Better comment formatting #87
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
* Add PEP8 2-space inline comment spacing, with unit test * Remove leading space in multiple comments in parameters (snakemake#85) * Add 4 failing test cases taken from snakemake#85
* Add infrastructure to unget tokens from parsed snakefile, with tests * Parameter values now parse comments occurring before, inline, and after them, with mechanism to detect unindented comments based on column position * Centralise functionality in `types.py`, eg PEP8 standards and Parameter class logic
* Bugfix: inline comments in inline-formatted keywords get relocated above keyword
* Add warning.py for logging warnings * Add warnings for comments when i)relocated and ii)Appear after code they seem to be documenting * Bugfix: block comments before inline-formatted values get relocated
Place config searching and parsing code to own file, config.py This de-clutters formatter.py and snakefmt.py
* When traversing source files, modify logger to output the processed file name; thus warnings and errors point to the raising file * De-mix stdout and stderr in CLI tests and refer to each specifically
Codecov Report
@@ Coverage Diff @@
## dev #87 +/- ##
==========================================
+ Coverage 97.59% 98.14% +0.55%
==========================================
Files 9 11 +2
Lines 791 864 +73
Branches 146 161 +15
==========================================
+ Hits 772 848 +76
+ Misses 9 8 -1
+ Partials 10 8 -2
Flags with carried forward coverage won't be shown. Click here to find out more.
|
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.
This PR mainly addresses #85, providing better formatting of comments.
It also adds code infrastructure for issuing warnings and ungetting tokens.
Added
to the raising source file.
Fixed
(All these bugs documented in #85)
With tests for each.
Changed
snakefmt.pyandformatter.pyto own sourcefile,
config.py