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

Removed trailing whitespace in docs. #18843

Merged
merged 1 commit into from
Nov 27, 2024

Conversation

adamzap
Copy link
Member

@adamzap adamzap commented Nov 24, 2024

Trac ticket number

N/A

Branch description

These were found using sphinx-lint, which was brought up in the Django Discord.

Checklist

  • This PR targets the main branch.
  • The commit message is written in past tense, mentions the ticket number, and ends with a period.
  • I have checked the "Has patch" ticket flag in the Trac system.
  • I have added or updated relevant tests.
  • I have added or updated relevant docs, including release notes if applicable.
  • I have attached screenshots in both light and dark modes for any UI changes.

@@ -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
Copy link
Member Author

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.
@adamzap adamzap force-pushed the remove-trailing-whitespace-in-docs branch from 480cf5d to b3fc54f Compare November 24, 2024 05:03
@shangxiao
Copy link
Contributor

shangxiao commented Nov 24, 2024

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 👍

@adamzap
Copy link
Member Author

adamzap commented Nov 24, 2024

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!

@nessita
Copy link
Contributor

nessita commented Nov 27, 2024

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!

Copy link
Contributor

@nessita nessita left a 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 " +$" {} \;

@nessita nessita merged commit e9ed5da into django:main Nov 27, 2024
34 checks passed
@nessita
Copy link
Contributor

nessita commented Nov 27, 2024

A side note: these changes cause conflicts in stable/5.1.x so I will not backport them (there is no need to do so).

@adamzap adamzap deleted the remove-trailing-whitespace-in-docs branch November 27, 2024 16:27
@smithdc1
Copy link
Member

@nessita do you think it is worth adding the commit for this to

https://github.com/django/django/blob/main/.git-blame-ignore-revs

@nessita
Copy link
Contributor

nessita commented Nov 28, 2024

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants