-
-
Notifications
You must be signed in to change notification settings - Fork 32.3k
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
Removed trailing whitespace in docs. #18843
Removed trailing whitespace in docs. #18843
Conversation
@@ -116,8 +116,8 @@ Minor features | |||
* The default iteration count for the PBKDF2 password hasher is increased from | |||
720,000 to 870,000. | |||
|
|||
* The default ``parallelism`` of the ``ScryptPasswordHasher`` is | |||
increased from 1 to 5, to follow OWASP recommendations. | |||
* The default ``parallelism`` of the ``ScryptPasswordHasher`` is increased from |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a trailing space on this line. In addition to removing it, I made the line longer since it seemed inconsistent.
Thanks to David Smith for trying to integrate `sphinx-lint`, which is how these were found.
480cf5d
to
b3fc54f
Compare
Hi Adam, just FYI small cleanups like this are generally avoided to reduce commit history noise - though Sarah or Nessita may have changed this policy recently and still accept it 👍 |
Ok, interesting! I don't mind if it gets closed though it could help with linting in the future. Is the goal of reducing commit history noise documented somewhere? This is just about all I could find about trivial changes, and it seems to encourage them: https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/submitting-patches/#typo-fixes-and-trivial-documentation-changes Thanks! |
Given that this is "in the way" of contributors when proposing PRs with docs changes (see being), I'm very much in favor of merging this. Will do so now! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great, thank you @adamzap! 🌟
I double checked with: find docs -type f -name '*.txt' -exec egrep -l " +$" {} \;
A side note: these changes cause conflicts in |
@nessita do you think it is worth adding the commit for this to https://github.com/django/django/blob/main/.git-blame-ignore-revs |
Thank you @smithdc1 for pointing this out. In all honesty, I did not know this file existed until now 🤯 To answer your inquiry, I've been browsing the git history, and as far as I can see, we haven't been been doing this addition for small formatting changes, see for example 0f694ce or 5a37255. I also consulted with Sarah and we agreed that it would be more suitable to only ignore revnos with larger changes. Lastly, my personal opinion is that having revnos listed in the git history but not in git blame is a bit unexpected, so I would prefer to stick with the current apparent pattern of ignoring big formatting revisions. |
Trac ticket number
N/A
Branch description
These were found using
sphinx-lint
, which was brought up in the Django Discord.Checklist
main
branch.