Skip to content

Conversation

@quantypi
Copy link

@quantypi quantypi commented Jul 24, 2025

  • Improved comment consistency for file level and embedded comments using the following structure:

multi-line left-aligned comment: /* and / on own line with no leading or trailing whitespace, respectively.
embedded (non left-aligned) comments: /
and / share line with first and last line of comment, respectively.
all comments: leading "
" removed for body of comment to match style majority of codebase.

  • Removed duplicate newlines.

  • Removed trailing whitespace.

  • Replaced tabs with spaces in all instances.

  • Fixed conditionals with spacing in parens.

  • Fixed redundant parens in return. Note that additional redundant parens exist but may be best for visual clarity (e.g. grouping expressions within a return expression to visually isolate from logical operators like ||).

quantypi and others added 4 commits July 23, 2025 17:10
…e comments, comment text, and additional const and functions.
…d /* and */ on own line) and code structure spacing for conditionals per PEP 7 - C Style. Removed additional leading "*" characters in multi-line comments.

Consider further addresing redundant parens in return statements per PEP 7, though some may be best for visual grouping.
@python-cla-bot
Copy link

python-cla-bot bot commented Jul 24, 2025

All commit authors signed the Contributor License Agreement.

CLA signed

@bedevere-app
Copy link

bedevere-app bot commented Jul 24, 2025

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

@StanFromIreland
Copy link
Member

Hello, thanks for your contribution, however we do not accept such cosmetic changes.

@quantypi quantypi changed the title Improved comment consistency for file level and embedded comments, unnecessary leading and trailing whitespace, duplicate newlines, conditional spacing, and redundant return parens per PEP 7. Suggested Improvements per PEP 7 - Style Guide for C Code Jul 24, 2025
@quantypi
Copy link
Author

@StanFromIreland, thank you for the quick reply. I adjusted my title/comments with more detail. Trying to get accustomed to the workflow here so wanted to start with some simple cleanup. There are many instances of trailing whitespace in violation of PEP 7, for example, are these all to be ignored?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants