-
Notifications
You must be signed in to change notification settings - Fork 438
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add notes to more accurately describe misaka library extensions #1017
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice, thank you!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for applying the feedback.
Per git
conventions and in order for this project to have a meaningful and well-searchable git
history, we ask contributors to keep commit title length to 50 characters and the body to a maximum of 80.
You can look at git log -- docs/
or browse the history of the docs/ folder to see examples of how commits should be formatted.
We also prefer you squash superfluous commits (this change should only consist of 1 logical commit since it only touches 1 file). You can do so with git rebase -i master
and change pick
to squash
. Otherwise our history would be littered with multiple rounds of PR feedback, making it difficult to track down with git blame
through which commit (and with which intentions/justification) changes to files were made.
Sorry for the wrong format, I've made the changes locally to squash the commits and re-phrase, then pushed it over the existing PR. I hope it's fine now, please have a look and let me know if other changes are necessary. |
c4c87a8
to
34fac9c
Compare
Thank you for taking the time on the reviews as well.
Yeah, the funny thing is that I noticed that, and actually did a "reword" when I squashed the commits and in my local logs it appeared fine; but for some reason it didn't update when I pushed things to GitHub :-/ Could be that my local copy became a bit confused with all the re-basing happening from the other commits that come in, so I deleted everything, re-pulled and re-based again, I hope it's fine now? |
Add notes to more accurately describe misaka library extensions
Merged, thanks! |
Added note to the "math" extension to clarify that it doesn't actually render any math, just marks it as ignored by the parser, so that it can be processed with external JavaScript libraries separately. Added notes to the "highlight", "tables" and "underline" extensions with the requirements for each to actually work when used.
Checklist
CHANGES.rst
because this is a user-facing change or an important bugfixWhat changes does this Pull Request introduce?
Documentation changes only -- clarifications on the functionality of
misaka
extensions.Why is this necessary?
The existing documentation was incomplete.