Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.rst #106

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README.rst #106

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b4b1d6
Update README.rst
pbelskiy Jul 14, 2022
c7b1179
Reworked examples until contentment
twolfson Jul 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,10 @@ Q003 Change outer quotes to avoid escaping inner quotes
Configuration
-------------

By default, we expect single quotes (') and look for unwanted double quotes ("). To expect double quotes (") and find unwanted single quotes ('), use the CLI option:
By default, we expect single quotes (') and look for unwanted double quotes ("), and
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I appreciate the effort here! I think this is a little more confusing though, since we're starting to talk about expectations in 2 different places.

It'd prob be better to split up each of the code samples with their relevant default and override settings (e.g. multiline, docstring).

Or simply add a default explainer to the existing comment lines

# We also support configuration for multiline quotes (default: """)

# We also support docstring quotes similarly (default: """)

What are your thoughts?

For personal reference: https://github.com/zheller/flake8-quotes/blob/3.3.1/flake8_quotes/__init__.py#L137-L139

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, we can go deeper here, but I think it's quite enough now just to write default behaviour, it will solve my and other developers misunderstanding.

expect double quotes (") in docstring.

To expect double quotes (") and find unwanted single quotes ('), use the CLI option:

.. code:: shell

Expand Down