Sourcery refactored master branch #1
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
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Comment on lines
-48
to
+50
| if new_param is None: | ||
| # if we still cannot find any new parameters, break | ||
| break | ||
| if new_param is None: | ||
| # if we still cannot find any new parameters, break | ||
| break |
There was a problem hiding this comment.
Function extract_params refactored with the following changes:
- Hoist conditional out of nested conditional (
hoist-if-from-if)
Comment on lines
-199
to
+204
| <kbd>{name}({", ".join([param for param in funcs[name]['parameters']])})</kbd><br><br> | ||
| <kbd>{name}({", ".join(list(funcs[name]['parameters']))})</kbd><br><br> | ||
| <p> | ||
| {funcs[name]['description']} | ||
| </p> | ||
| """ | ||
|
|
There was a problem hiding this comment.
Function functions_html refactored with the following changes:
- Replace identity comprehension with call to collection constructor (
identity-comprehension) - Replace f-string with no interpolated values with string [×2] (
remove-redundant-fstring)
Comment on lines
-266
to
-270
| # !!! TODO make the navbar code here | ||
| navbar = "" | ||
|
|
||
| # now save to templates within the docs directory | ||
| output(navbar, 'navbar.js', os.path.join(docs_dir, 'templates')) |
There was a problem hiding this comment.
Function build_navbar refactored with the following changes:
- Remove unreachable code (
remove-unreachable-code)
This removes the following comments ( why? ):
# now save to templates within the docs directory
# !!! TODO make the navbar code here
Comment on lines
-319
to
+317
| if submodule != "": | ||
| fullpath = [module, submodule] | ||
| else: | ||
| fullpath = [module] | ||
|
|
||
| fullpath = [module, submodule] if submodule != "" else [module] |
There was a problem hiding this comment.
Function build_page refactored with the following changes:
- Replace if statement with if expression (
assign-if-exp) - Replace f-string with no interpolated values with string (
remove-redundant-fstring)
Comment on lines
-478
to
+473
| if not any([ext in filename for ext in file_types]): | ||
| if all(ext not in filename for ext in file_types): |
There was a problem hiding this comment.
Function output refactored with the following changes:
- Invert any/all to simplify comparisons (
invert-any-all) - Replace unneeded comprehension with generator (
comprehension-to-generator) - Swap if/else to remove empty if body (
remove-pass-body)
Comment on lines
-517
to
+510
|
|
There was a problem hiding this comment.
Found the following improvement in Function bootstrap_download:
| if not any([os.path.exists(loc) for loc in bootstraps]): | ||
| if not any(os.path.exists(loc) for loc in bootstraps): | ||
| # if any do not exist, we download all | ||
| print("Not all required Bootstrap files found. " | ||
| "They will be downloaded to " | ||
| f"'{os.path.join(docs_dir, 'templates')}'.") | ||
| # download bootstrap files | ||
| bootstrap_download(docs_dir) | ||
|
|
There was a problem hiding this comment.
Function DocsBuilder.__init__ refactored with the following changes:
- Replace unneeded comprehension with generator (
comprehension-to-generator)
Comment on lines
-614
to
+609
| if new_class is None: | ||
| # if no classes anywhere, break the loop | ||
| break | ||
| if new_class is None: | ||
| # if no classes anywhere, break the loop | ||
| break |
There was a problem hiding this comment.
Function DocsBuilder.extract refactored with the following changes:
- Hoist conditional out of nested conditional (
hoist-if-from-if)
Comment on lines
-668
to
+681
| # we may end up with multiple pages, so initialise Dictionary | ||
| pages = {} | ||
| # filename version of module | ||
| filename = self.module.lower().replace(" ", "_") | ||
| # build top-level page | ||
| pages[filename] = \ | ||
| build_page(self.module, self.devs, self.desc, self.classes, | ||
| self.funcs) | ||
| pages = { | ||
| filename: build_page( | ||
| self.module, self.devs, self.desc, self.classes, self.funcs | ||
| ) | ||
| } | ||
|
|
||
| # iterate through classes (if any) and build page for each | ||
| if len(self.classes) > 0: | ||
| for c in self.classes: | ||
| print(f"{filename}.{c}") | ||
| print(c) | ||
| pages[f"{filename}.{c}"] = \ | ||
| build_page(self.module, self.devs, | ||
| build_page(self.module, self.devs, | ||
| self.classes[c]['description'], classes="", | ||
| funcs=self.classes[c]['funcs'], submodule=c) | ||
|
|
||
| # finally save all to file | ||
| for page in pages: | ||
| output(pages[page], page, path=path) | ||
| for page, value in pages.items(): | ||
| output(value, page, path=path) |
There was a problem hiding this comment.
Function DocsBuilder.build refactored with the following changes:
- Move assignment closer to its usage within a block (
move-assign-in-block) - Use items() to directly unpack dictionary values (
use-dict-items) - Merge dictionary assignment with declaration (
merge-dict-assign)
This removes the following comments ( why? ):
# we may end up with multiple pages, so initialise Dictionary
# build top-level page
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.
Branch
masterrefactored by Sourcery.If you're happy with these changes, merge this Pull Request using the Squash and merge strategy.
See our documentation here.
Run Sourcery locally
Reduce the feedback loop during development by using the Sourcery editor plugin:
Review changes via command line
To manually merge these changes, make sure you're on the
masterbranch, then run:Help us improve this pull request!