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

Recast key docs to be much clearer and more accurate #2540

Merged
merged 2 commits into from
Oct 11, 2019

Conversation

dead-claudia
Copy link
Member

Description

  • Recast key docs to be much clearer and more accurate, including a few Flems examples to help intuitively explain things
  • Also, fix a couple broken hash links I noticed while making this.

Motivation and Context

How Has This Been Tested?

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation change

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have updated docs/change-log.md

Also, fix a couple broken hash links I noticed while making this.
@dead-claudia dead-claudia merged commit 512eef3 into MithrilJS:next Oct 11, 2019
@dead-claudia dead-claudia deleted the docs-key-fix branch October 11, 2019 08:29
@JAForbes JAForbes mentioned this pull request Apr 28, 2022
StephanHoyer pushed a commit that referenced this pull request May 16, 2022
* Recast key docs to be much clearer and more accurate [skip ci]

Also, fix a couple broken hash links I noticed while making this.

* Ensure `diff` blocks are highlighted correctly
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Closed
Development

Successfully merging this pull request may close these issues.

The keys documentation is creating confusion and needs fixed soon.
1 participant