Skip to content
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

Closed
wants to merge 2 commits into from

Conversation

mgc8
Copy link
Contributor

@mgc8 mgc8 commented Apr 26, 2024

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

  • All new and existing tests are passing
  • (If adding features:) I have added tests to cover my changes
  • (If docs changes needed:) I have updated the documentation accordingly.
  • I have added an entry to CHANGES.rst because this is a user-facing change or an important bugfix
  • I have written proper commit message(s)

What 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.

Copy link
Member

@ix5 ix5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thank you!

docs/docs/reference/markdown-config.rst Outdated Show resolved Hide resolved
docs/docs/reference/markdown-config.rst Outdated Show resolved Hide resolved
docs/docs/reference/markdown-config.rst Outdated Show resolved Hide resolved
docs/docs/reference/markdown-config.rst Outdated Show resolved Hide resolved
@mgc8 mgc8 requested a review from ix5 April 29, 2024 17:38
Copy link
Member

@ix5 ix5 left a 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.

@mgc8 mgc8 changed the title Add notes to more accurately describe misaka library extension functi… Add notes to more accurately describe misaka library extensions Apr 29, 2024
@mgc8
Copy link
Contributor Author

mgc8 commented Apr 29, 2024

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.

@mgc8 mgc8 requested a review from ix5 April 29, 2024 20:55
@ix5
Copy link
Member

ix5 commented Apr 29, 2024

Thank you.

One last thing, please fix the commit title length. E.g. docs: markdown-config: Clarify misaka config would be succinct enough.

We'd want to avoid this:
Screenshot from 2024-04-29 23-14-31

@mgc8 mgc8 force-pushed the patch-1 branch 2 times, most recently from c4c87a8 to 34fac9c Compare April 29, 2024 22:08
@mgc8
Copy link
Contributor Author

mgc8 commented Apr 29, 2024

Thank you for taking the time on the reviews as well.

One last thing, please fix the commit title length. E.g. docs: markdown-config: Clarify misaka config would be succinct enough.

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?

ix5 added a commit that referenced this pull request May 3, 2024
Add notes to more accurately describe misaka library extensions
@ix5 ix5 closed this May 3, 2024
@ix5
Copy link
Member

ix5 commented May 3, 2024

Merged, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants