Pre-commit and format markdown #682
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
nllong
force-pushed
the
fall-2024-docs-formatting
branch
from
2bcf99f to
ac94cea
Compare
Merged
vtnate
approved these changes
Dec 17, 2024
| @@ -155,7 +155,7 @@ def replace_within_string(self, new_string: str) -> None: | |||
| """ | |||
| self.within = new_string | |||
|
|
|||
| def find_model_object(self, obj_name: str) -> Tuple[Union[int, None], Union[str, None]]: | |||
| def find_model_object(self, obj_name: str) -> tuple[Union[int, None], Union[str, None]]: | |||
There was a problem hiding this comment.
Since we now require Python 3.10, type hints can be simpler. We don't need to import Union any more, we can just do tuple[int | None, str | None]. I think (though I'm less confident) we also don't need to import Any now either.
Mostly meant as a reminder, not suggesting we tear apart the code looking for that!
| - repo: https://github.com/igorshubovych/markdownlint-cli | ||
| rev: v0.43.0 | ||
| hooks: | ||
| - id: markdownlint |
There was a problem hiding this comment.
Linting in pre-commit is good for the soul 🫶
vtnate
added a commit
that referenced
this pull request
Dec 17, 2024
* remind users they may need to scroll to see MBL version in compatibility matrix * remove `update_schemas` script * initial changes to text * change dependencies to use mkdocs for documentation * config file for mkdocs * ignore intermediate schema conversion files for docs site * rename sys-param schema file to be more descriptive * improve release & docs documentation * re-organize dev dependencies * new mkdocs version of documentation, removing rst * GHA workflow to deploy docs * add link to docs site at top of readme * remove sphinx docs build from CI * rename overview doc file for intuitive nav * put authors file into a markdown table * Pre-commit and format markdown (#682) * initial formatting * fix issues, general cleanup * un-indent code blocks, fix changelog header * e.g., and i.e., --------- Co-authored-by: Nicholas Long <[email protected]> Co-authored-by: Nicholas Long <[email protected]>
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.
Any background context you want to provide?
Small tweaks to the updated mkdocs migration!
What does this PR accomplish?