docs: delete redundant comments #64
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The sorting of imports follows best practices (standard, third-party, internal) which is also enforced by running isort in CI. Having these comments in every module is thus redundant and only unnecessarily increases lines of code in each module. Moreover, at some places the comment was misplaced, e.g. in `edvart/report_sections/dataset_overview.py` the comment about internal imports was in between the imports.
lukany
force-pushed
the
docs/delete-unnecessary-comments
branch
from
c49162e
to
af05d92
Compare
mbelak-dtml
approved these changes
Aug 7, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The sorting of imports follows best practices
(standard, third-party, internal) which is also enforced by running
isort in CI.
Having these comments in every module is thus redundant and only
unnecessarily increases lines of code in each module.
Also, it can potentially lead to inconsistency when creating new
modules — one can easily forget to put these comments in new modules.