📚 Add docstrings to parts of myst-cli #850
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
agoose77
commented
Jan 12, 2024
agoose77
commented
Jan 12, 2024
agoose77
commented
Jan 12, 2024
agoose77
commented
Jan 12, 2024
|
I would love to get these changes in. I think that it would be helpful to break them up into independent PRs I think though, which would really help in reviewing and merging speed. Potentially like 3-4 PRs - one on doc strings, one on the loading refactor, removing the HTML comments handler, and one on limiting the articles length. I can help with the cherry-picking/rebasing if you want. We can talk more on monday! |
agoose77
force-pushed
the
agoose77/refactor-and-docstrings-1
branch
from
502dd3b to
70a1acd
Compare
agoose77
changed the title
|
@rowanc1 this PR is now just docstrings! :) |
fwkoch
changed the title
|
@agoose77 -- just for clarity, the other changes ideally can come in as well, just broken up so they can be reviewed independently! Hoping you have some of the changes locally. :) Thanks for your help in cleaning these up! |
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 changes no functionality; I wanted to familiarise myself with some of the inner workings through refactoring. There are some new docstrings that mostly state the obvious but it's a start.