Documentation/readme #53
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…so edited and bolded commands in the table to make the examples more clear
|
Looking good... 👍 yes 'readme.rst' is for pypi. I usually generate it automatically from readme.md using a tool named pandoc. Thanks for updating it as well. |
|
Kudos 🥇 @aaxu |
gautamkrishnar
pushed a commit
that referenced
this pull request
May 22, 2017
…e search, and manual search (#56) * Fixed some quick spelling mistakes, capitalization, and bolding a title * Fixed more typoes and reworded some phrases to make it more clear. Also edited and bolded commands in the table to make the examples more clear * Quick capitalization fix * Documentation/readme (#53) * Fixed some quick spelling mistakes, capitalization, and bolding a title * Fixed more typoes and reworded some phrases to make it more clear. Also edited and bolded commands in the table to make the examples more clear * Quick capitalization fix * Reduced chance of crashing when using basic query command which utilizes Google Search * Implemented Google Search for interactive mode and manual search as well * Refactored some code to avoid rewriting and tested for correctness * Quick fix to delete unneeded line
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello @gautamkrishnar,
I made a few changes to both README files to make them more clear. I hope you can check whether it still retains the same meanings that were originally there. A few things I did was capitalize "Stack Overflow" and "Python". Other than that, I also bolded the commands in the table to make them more clear. I made the same changes to both files. I assumed that when you said Python 2+, you meant Python 2.0 or higher. Could you possibly mean 2.6 or higher or is 2.0 fine as well?
I also assumed that the README.md file was to be used for GitHub and the README.rst file was for https://pypi.python.org/pypi/socli (Please correct me if I'm wrong). I noticed that there were some new line syntax errors in the Features and To Do section on the website, but I haven't addressed that yet, since I haven't looked up how to edit .rst files correctly yet.