Add linting, formatting #2
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
nealkruis
reviewed
Dec 12, 2023
.pylintrc
Outdated
Comment on lines
584
to
585
| overgeneral-exceptions=BaseException, | ||
| Exception |
There was a problem hiding this comment.
pylint: Command line or configuration file:1: UserWarning: 'BaseException' is not a proper value for the 'overgeneral-exceptions' option. Use fully qualified name (maybe 'builtins.BaseException' ?) instead. This will cease to be checked at runtime when the configuration upgrader is released.
pylint: Command line or configuration file:1: UserWarning: 'Exception' is not a proper value for the 'overgeneral-exceptions' option. Use fully qualified name (maybe 'builtins.Exception' ?) instead. This will cease to be checked at runtime when the configuration upgrader is released.
.github/workflows/test.yaml
Outdated
| continue-on-error: true | ||
| - name: Static type checking | ||
| run: | | ||
| poetry run mypy atheneum #'${{github.workspace}} |
There was a problem hiding this comment.
Do we want to run this on our tests, too?
There was a problem hiding this comment.
I was thinking not, actually. If we're writing tests that are typing-complicated, we have bigger problems. But I guess I don't mind either way.
atheneum/atheneum.py
Outdated
| def __init__(self) -> None: | ||
| pass | ||
|
|
||
| def answer(self, exclamation_str): |
There was a problem hiding this comment.
Sarcasm is unbecoming.
atheneum/atheneum.py
Outdated
Comment on lines
10
to
14
| """ | ||
| Return the answer to Life, the Universe, and Everything. | ||
|
|
||
| :param exclamation_str: Print how you feel about the answer | ||
| """ |
There was a problem hiding this comment.
At some point we'll want to standardize how we do API documentation. I assume this is a standard syntax for something like sphynx?
There was a problem hiding this comment.
Yeah, this is ReStructured Text that sphinx uses. Tthis looks like a pointless function signature, but I wanted to contrive an example to use the RST comments...
nealkruis
approved these changes
Dec 22, 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.
This branch contains CI actions for checking pylint output and mypy output.
An example of ReStructured Text (sphinx) comment style is also included in a source file.