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

Update FAQ to reflect the default value of src #13134

Closed
dhruvmanila opened this issue Aug 28, 2024 · 2 comments · Fixed by #13145
Closed

Update FAQ to reflect the default value of src #13134

dhruvmanila opened this issue Aug 28, 2024 · 2 comments · Fixed by #13145
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@dhruvmanila
Copy link
Member

Update to FAQ.md at https://github.com/astral-sh/ruff/blob/main/docs/faq.md is merited as a result of this change I think.

Specifically, the following bullet can be removed:

Depending on your project structure, Ruff and isort can differ in their detection of first-party code. (This is often solved by modifying the src property, e.g., to src = ["src"], if your code is nested in a src directory.)

Originally posted by @NasaGeek in #12848 (comment)

@dhruvmanila dhruvmanila added documentation Improvements or additions to documentation good first issue Good for newcomers labels Aug 28, 2024
@dhruvmanila
Copy link
Member Author

I think we should instead highlight the fact that this was changed in 0.6 instead of removing the bullet point.

@astral-sh astral-sh deleted a comment Aug 28, 2024
PalAditya added a commit to PalAditya/ruff that referenced this issue Aug 29, 2024
@PalAditya
Copy link
Contributor

Hi @dhruvmanila - I love Ruff and wanted to contribute to it for some time, so just made a PR for this: #13145 . I didn't see anything in the contributing guidelines about prior assignment, but please let me know if it needs changes/I should have completed some pre-requisite first if you get a chance to review this.

dhruvmanila pushed a commit that referenced this issue Aug 29, 2024
This attempts to close #13134

## Summary

Documentation change to address
#13134

## Test Plan

Markdown Changes were previewed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants