update formatting throughout codebase #475
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
stevebachmeier
commented
Aug 27, 2024
| @@ -358,33 +357,39 @@ class Builder: | |||
|
|
|||
| Attributes | |||
| ---------- | |||
| logging: LoggingInterface | |||
| configuration : ``LayeredConfigTree`` | |||
There was a problem hiding this comment.
I couldn't get this to work so I just kept it nit-picked. Quotes didn't work but for some reason double back-ticks did 🤷♂️
stevebachmeier
commented
Aug 27, 2024
| @@ -50,6 +50,7 @@ | |||
| # ones. | |||
| extensions = [ | |||
| "sphinx.ext.autodoc", | |||
| "sphinx_autodoc_typehints", | |||
There was a problem hiding this comment.
This is the thing that allows us to not type hint parameters and returns in the docstring even though we already have them typed in the signature.
stevebachmeier
requested review from
albrja,
collijk,
hussain-jafari,
patricktnast and
rmudambi
as code owners
albrja
approved these changes
Aug 27, 2024
rmudambi
approved these changes
Aug 27, 2024
stevebachmeier
force-pushed
the
feature/sbachmei/MIC-5243-numpy-style-consistency
branch
from
199bacd to
98a55b0
Compare
stevebachmeier
deleted the
feature/sbachmei/MIC-5243-numpy-style-consistency
branch
stevebachmeier
added a commit
that referenced
this pull request
Aug 28, 2024
stevebachmeier
added a commit
that referenced
this pull request
Aug 28, 2024
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Update formatting
Description
Changes and notes
We previously settled on sticking with numpy style documentation.This PR makes small tweaks for consistency. Most notably, it implements
a new type hints extension so that we do not need to duplicate
type hints in the signature as well as the docstring.
Testing