Markdown fixes #736
Merged
Markdown fixes #736
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
Fixed markdown formatting for clarity and readability. Modified charts for better readability. Edited some explanations to match chart changes and for clarity. Fixed table of contents and section title links so they work. Fixed file name for lua example so the link to it works. Fixed minor spelling errors.
I went through all the data structures pages and added or fixed a table of contents if the page was more than about a page and a half. There were some pages that didn't have use case examples for the data structures, so I added those as well.
|
The Label Bot has predicted the following:
|
shhossain
approved these changes
Feb 25, 2024
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.
Proposed changes
Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. Your PR title can be also used here.
Types of changes
What types of changes does your content introduce to this project?
Put an
xin the boxes that apply (without "`")Checklist
Put an
xin the boxes that apply. You can also fill these out after creating the PR. Don't hesitate to ask if you're unsure about any of them. We're here to help! This simply reminds us of what we will look for before merging your code.Note: If you submit code make sure to test it
Further comments
Went through the data structures explanations and tried to make the formatting more consistent by adding or fixing a table of contents.
Added use case section for some data structures explanations that didn't already include them.
Adding your name to the contributor's list
Comment "@all-contributors please add @your_username for content" to add your name to the contributor's list.
You can change the "content" with any of this
Reviewers:
Please ensure that you are not adding any sensitive information like API keys, secrets, passwords, tokens, usernames, or other credentials. Refrain from adding your name, email, or other personal information.