Skip to content

Update documentation about comments to include mention of hashbangs.#3787

Merged
hauntsaninja merged 4 commits into
psf:mainfrom
mqyhlkahu:docfix
Jul 11, 2023
Merged

Update documentation about comments to include mention of hashbangs.#3787
hauntsaninja merged 4 commits into
psf:mainfrom
mqyhlkahu:docfix

Conversation

@mqyhlkahu
Copy link
Copy Markdown
Contributor

Description

The documentation previously lacked a mention of how hashbangs are handled. Now, the documentation mentions that hashbangs are excepted from the comment spacing rules. This fixes issue #3786.

Checklist - did you ...

  • Add an entry in CHANGES.md if necessary?
  • Add / update tests if necessary?
  • Add new / update outdated documentation?

mqyhlkahu and others added 2 commits July 11, 2023 14:00
The documentation previously lacked a mention of how hashbangs are handled.  Now, the documentation mentions that hashbangs are excepted from the comment spacing rules.  This fixes issue #3786.
Copy link
Copy Markdown
Collaborator

@hauntsaninja hauntsaninja left a comment

Choose a reason for hiding this comment

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

Thanks! Suggesting using "shebangs" since that's the more common term (as per wikipedia)

Comment thread docs/the_black_code_style/current_style.md Outdated
mqyhlkahu and others added 2 commits July 11, 2023 14:12
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
@JelleZijlstra JelleZijlstra added the ci: skip news Pull requests that don't need a changelog entry. label Jul 11, 2023
@hauntsaninja hauntsaninja merged commit 6123b4a into psf:main Jul 11, 2023
@hauntsaninja
Copy link
Copy Markdown
Collaborator

Thank you!

@mqyhlkahu mqyhlkahu deleted the docfix branch July 11, 2023 19:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci: skip news Pull requests that don't need a changelog entry.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants