README: elaborate of some noteworthy usage flags #143

luzpaz · 2017-10-04T15:09:32Z

Also offer some examples.
Devs, this PR needs feedback. I'm not familiar with .rst format so much. I am pretty sure tweaks are needed.

codecov-io · 2017-10-04T15:15:34Z

Codecov Report

Merging #143 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #143   +/-   ##
=======================================
  Coverage   89.01%   89.01%           
=======================================
  Files           3        3           
  Lines         619      619           
  Branches       86       86           
=======================================
  Hits          551      551           
  Misses         53       53           
  Partials       15       15

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b50382a...70809c0. Read the comment docs.

larsoner · 2017-10-04T15:23:55Z

You can use the GitHub interface to see the rendered version:

https://github.com/luzpaz/codespell/blob/8b6b2406a269353ff6710011f0bfd861dc9ed2be/README.rst

luzpaz · 2017-10-04T16:07:59Z

Ok, i fixed the formatting issue AFAICT. .rst seems like a weird format at least to me. How does it read? Ok?

larsoner · 2017-10-04T16:11:52Z

README.rst

+
+    codespell -w, --write-changes
+
+The -w flag will actually implement the changes recommended by codespell. Not running with ``-w`` flag is equated with doing a dry run. Recommended to run this with the ``-i`` or ``--ineractive`` flag.:: 


is equated -> is the same as

Recommended to -> It is recommended to

--ineractive -> --interactive

larsoner · 2017-10-04T16:12:19Z

README.rst

+
+    codespell -S, --skip=
+
+Comma-separated list of files to skip. It accepts globs as well.  Example:


larsoner · 2017-10-04T16:12:27Z

README.rst

+
+Comma-separated list of files to skip. It accepts globs as well.  Example:
+
+to skip .eps & .txt files, invoke ``codespell --skip="*.eps,*.txt"``  


* to skip ...

larsoner · 2017-10-04T16:12:35Z

README.rst

+
+to skip .eps & .txt files, invoke ``codespell --skip="*.eps,*.txt"``  
+
+to skip directories, invoke ``codespell --skip="./src/3rd-Party,./src/Test"`` ::


* to skip ...

larsoner · 2017-10-04T16:13:06Z

README.rst

+
+    codespell -I FILE, --ignore-words=FILE
+
+This flag can be used to whitelist certain words that are in the ``codespell_lib/data/dictionary.txt``. Format of whitelist file is one word per line. Invoke ``codespell -I path/to/file.txt`` to execute codespell referencing said whitelist. 


Format of whitelist -> The format of the whitelist

larsoner · 2017-10-04T16:17:15Z

README.rst

+
+    codespell -i 3 -w
+
+Will run interactive mode level 3 and write changes to file.


Will run -> Run

luzpaz · 2017-10-04T16:55:56Z

the whitelist passed to -I is case-sensitive based on how it is listed in dictionary.txt.
for example after running codespell, the following results could be displayed:
allEdges ==> alleges
in order to whitelist this word you need to lowercaseallEdges since that is how it is listed in dictionary.txt
Not sure how to covey that in the README. Thoughts?

larsoner · 2017-10-05T00:08:48Z

I think you can just say that "The whitelist passed to -I is case-sensitive based on how it is listed in dictionary.txt.", and people in these corner cases will figure out the correct usage.

luzpaz · 2017-10-05T03:13:51Z

I think you can just say that "The whitelist passed to -I is case-sensitive based on how it is listed in dictionary.txt.", and people in these corner cases will figure out the correct usage.

👍

luzpaz · 2017-10-05T17:05:17Z

I added a section on upgrading using pip. Please offer feedback as well. Thanks!

larsoner · 2017-10-05T20:07:43Z

README.rst

+--------
+To stay current with codespell developments it is possible to build codespell from GitHub via::
+
+    pip3 install --upgrade git+https://github.com/lucasdemarchi/codespell.git


We should just say pip and assume this links to the correct place (people who need to use pip3 instead of pip hopefully already understand their environment)

larsoner · 2017-10-05T20:07:57Z

README.rst

+
+    pip3 install --user --upgrade git+https://github.com/lucasdemarchi/codespell.git
+
+* It has been reported that after installing from `pip`, codespell can't be located. Please check the $PATH variable to see if `~/.local/bin` is present. If it isn't then add it to your path. 


double-backticks on inline code in RST format (otherwise it's interpreted as a link)

larsoner · 2017-10-05T20:08:08Z

README.rst

+    pip3 install --user --upgrade git+https://github.com/lucasdemarchi/codespell.git
+
+* It has been reported that after installing from `pip`, codespell can't be located. Please check the $PATH variable to see if `~/.local/bin` is present. If it isn't then add it to your path. 
+* If you decide to install via `pip` then be sure to remove any previously installed versions of codespell (via you OSs preferred app mananger). 


luzpaz · 2017-10-05T21:28:22Z

@larsoner
double backticks are visible? How do I hide them and make sure that command is not interpreted as a link? See screenshot:

larsoner · 2017-10-06T15:14:06Z

README.rst

+--------
+To stay current with codespell developments it is possible to build codespell from GitHub via::
+
+    ``pip install --upgrade git+https://github.com/lucasdemarchi/codespell.git``


don't use double-backticks in code blocks

larsoner · 2017-10-06T15:14:22Z

README.rst

+    ``pip install --upgrade git+https://github.com/lucasdemarchi/codespell.git``
+
+**Important Notes:**
+* Sometimes installing via `pip` will complain about permissions. If this is the case then run with ::


use double-backticks here for pip (with inline code)

larsoner · 2017-10-06T15:14:32Z

README.rst

+
+    ``pip install --user --upgrade git+https://github.com/lucasdemarchi/codespell.git``
+
+* It has been reported that after installing from `pip`, codespell can't be located. Please check the $PATH variable to see if `~/.local/bin` is present. If it isn't then add it to your path. 


and here, pip and ~/local/bin

see how they don't render properly

https://github.com/luzpaz/codespell/blob/ace6c0d9b84c74fa9fff698bdab6763b90cd1ae8/README.rst

Also offer some examples. and added an Update section final

luzpaz · 2017-10-06T15:48:14Z

Ok, just not used to .RST
Thanks for your patience. I fixed the issues you mentioned and also refined a few more I found. I think this is good to go after this.

larsoner · 2017-10-06T15:51:11Z

Thanks @luzpaz

luzpaz force-pushed the README-elaborations branch from 99d9d69 to 1e48e3a Compare October 4, 2017 16:06

larsoner reviewed Oct 4, 2017

View reviewed changes

luzpaz mentioned this pull request Oct 4, 2017

Add new --ignore-words option to ignore 'good' words #100

Merged

luzpaz force-pushed the README-elaborations branch 3 times, most recently from 65e8611 to d33a91a Compare October 4, 2017 19:49

luzpaz force-pushed the README-elaborations branch from d33a91a to a93d633 Compare October 5, 2017 03:13

larsoner reviewed Oct 5, 2017

View reviewed changes

luzpaz force-pushed the README-elaborations branch from 8f9c1ce to 703ab37 Compare October 5, 2017 21:22

luzpaz force-pushed the README-elaborations branch from 703ab37 to ace6c0d Compare October 5, 2017 23:57

larsoner reviewed Oct 6, 2017

View reviewed changes

README: elaborate of some noteworthy usage flags

70809c0

Also offer some examples. and added an Update section final

luzpaz force-pushed the README-elaborations branch from ace6c0d to 70809c0 Compare October 6, 2017 15:46

larsoner merged commit 5cda413 into codespell-project:master Oct 6, 2017

luzpaz deleted the README-elaborations branch October 6, 2017 16:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README: elaborate of some noteworthy usage flags #143

README: elaborate of some noteworthy usage flags #143

luzpaz commented Oct 4, 2017

codecov-io commented Oct 4, 2017 •

edited

Loading

larsoner commented Oct 4, 2017

luzpaz commented Oct 4, 2017

larsoner Oct 4, 2017

luzpaz Oct 4, 2017

larsoner Oct 4, 2017

luzpaz Oct 4, 2017

larsoner Oct 4, 2017

luzpaz Oct 4, 2017

larsoner Oct 4, 2017

luzpaz Oct 4, 2017

larsoner Oct 4, 2017

luzpaz Oct 4, 2017

larsoner Oct 4, 2017

luzpaz Oct 4, 2017

luzpaz commented Oct 4, 2017 •

edited

Loading

larsoner commented Oct 5, 2017

luzpaz commented Oct 5, 2017

luzpaz commented Oct 5, 2017

larsoner Oct 5, 2017

larsoner Oct 5, 2017

larsoner Oct 5, 2017

luzpaz commented Oct 5, 2017

larsoner Oct 6, 2017

larsoner Oct 6, 2017

larsoner Oct 6, 2017

larsoner Oct 6, 2017

luzpaz commented Oct 6, 2017

larsoner commented Oct 6, 2017


		codespell -w, --write-changes

		The -w flag will actually implement the changes recommended by codespell. Not running with ``-w`` flag is equated with doing a dry run. Recommended to run this with the ``-i`` or ``--ineractive`` flag.::


		codespell -S, --skip=

		Comma-separated list of files to skip. It accepts globs as well. Example:


		Comma-separated list of files to skip. It accepts globs as well. Example:

		to skip .eps & .txt files, invoke ``codespell --skip=".eps,.txt"``


		to skip .eps & .txt files, invoke ``codespell --skip=".eps,.txt"``

		to skip directories, invoke ``codespell --skip="./src/3rd-Party,./src/Test"`` ::


		codespell -I FILE, --ignore-words=FILE

		This flag can be used to whitelist certain words that are in the ``codespell_lib/data/dictionary.txt``. Format of whitelist file is one word per line. Invoke ``codespell -I path/to/file.txt`` to execute codespell referencing said whitelist.


		codespell -i 3 -w

		Will run interactive mode level 3 and write changes to file.


		pip3 install --user --upgrade git+https://github.com/lucasdemarchi/codespell.git

		* It has been reported that after installing from `pip`, codespell can't be located. Please check the $PATH variable to see if `~/.local/bin` is present. If it isn't then add it to your path.


		``pip install --user --upgrade git+https://github.com/lucasdemarchi/codespell.git``

		* It has been reported that after installing from `pip`, codespell can't be located. Please check the $PATH variable to see if `~/.local/bin` is present. If it isn't then add it to your path.

README: elaborate of some noteworthy usage flags #143

README: elaborate of some noteworthy usage flags #143

Conversation

luzpaz commented Oct 4, 2017

codecov-io commented Oct 4, 2017 • edited Loading

Codecov Report

larsoner commented Oct 4, 2017

luzpaz commented Oct 4, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

luzpaz commented Oct 4, 2017 • edited Loading

larsoner commented Oct 5, 2017

luzpaz commented Oct 5, 2017

luzpaz commented Oct 5, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

luzpaz commented Oct 5, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

luzpaz commented Oct 6, 2017

larsoner commented Oct 6, 2017

codecov-io commented Oct 4, 2017 •

edited

Loading

luzpaz commented Oct 4, 2017 •

edited

Loading