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.

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

Fix ruff.toml examples in the documentation #8505

Closed
CharlesPerrotMinotHCHB opened this issue Nov 6, 2023 · 5 comments · Fixed by #8670
Closed

Fix ruff.toml examples in the documentation #8505

CharlesPerrotMinotHCHB opened this issue Nov 6, 2023 · 5 comments · Fixed by #8670
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@CharlesPerrotMinotHCHB
Copy link

Hi,
Thank so much for tuff! Love it so far.

There are a couple inconsistencies in the documentation for settings, where the value given as an example for what to use in the ruff.toml is the one to put in the pyproject.toml ; it has tool.ruff. in the the section name.

@CharlesPerrotMinotHCHB CharlesPerrotMinotHCHB changed the title Fix ruff.toml exemples in the documentation Fix ruff.toml examples in the documentation Nov 6, 2023
@charliermarsh charliermarsh added bug Something isn't working documentation Improvements or additions to documentation labels Nov 6, 2023
@charliermarsh
Copy link
Member

Thanks a lot for reporting this, good catch (the dual pyproject.toml and ruff.toml tabs are new).

@doolio
Copy link
Contributor

doolio commented Nov 6, 2023

@doolio
Copy link
Contributor

doolio commented Nov 6, 2023

Do you want the ruff.toml tab labels to include .ruff.toml as well i.e. something like ruff.toml/.ruff.toml or perhaps it would look better to have .ruff.toml as an additional tab but the same content as ruff.toml?

Edit: There is also an inconsistency in the markdown source blocks where for some the entire block is indented and for others it is not. Do you have a preference so I could apply the same style consistently?

Edit2: I can't seem to find the settings.md (or rules.md) file(s) in the docs folder.

@doolio
Copy link
Contributor

doolio commented Nov 6, 2023

I also noticed the tabs have not been added to all the FAQs.
I will submit a PR.

See #8512 for consideration.

@trag1c
Copy link
Contributor

trag1c commented Nov 6, 2023

Edit: There is also an inconsistency in the markdown source blocks where for some the entire block is indented and for others it is not. Do you have a preference so I could apply the same style consistently?

As far as I'm concerned indented code blocks are only used for tabs because that's the syntax they require (up until my change you couldn't even have indented code blocks because CI would fail otherwise).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants