Refine docs + README #128
Merged
Refine docs + README #128
Conversation
This file contains hidden or 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
machow
requested changes
May 24, 2022
There was a problem hiding this comment.
@juliasilge thanks for these tweaks!
- Do you mind trying to run pre-commit? Should be able to install using
pip install pre-commit; pre-commit install;. It will run automatically on any files you commit, but to get it caught up with theses changes, you can run..pre-commit run --all. - The .Rmd generates the .md (can run
make README.md). I noticed the README.md now has##in its output. Were these added manually? I'm not sure of a good way to do it when rendering, but can look into it if useful!
(also I don't mind picking things up and rebuilding the README.md / merging if useful)
|
Ah, I used knitr instead of |
|
I would so appreciate you finishing up this PR (for example, fixing the note box and other loose ends)! 🙌 |
|
regenerated readme and applied the fix to the note directive! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 refines the docs a bit as we get more eyes on this.
Do you know why the note box in this section generates an error?