Repository navigation
refactor(markdown-toolkit): rename Rendering to MarkdownInternals - #196
Merged
Merged
Conversation
The type holds the non-public side of an element: its syntax tree and the style to write it out with. Nothing in it has been rendered, so "Rendering" named the wrong thing, and the key, the function and the local variables all took that name from it. The type is now `MarkdownInternals`, and the rest follow: `markdownInternalsKey`, `markdownInternalsOf` and `markdownInternals`. No behavior changes.
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
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.
Summary
The internal
Renderingtype is nowMarkdownInternals, and the names that came from it follow. The type holds the non-public side of an element, its syntax tree and its style, and nothing in it has been rendered. No behavior changes.Changes
Names. Each took its name from the type:
RenderingMarkdownInternalsrenderingKeymarkdownInternalsKeyrenderingOf(value)markdownInternalsOf(value)rendering(local variable)markdownInternalsComments. The key's and the function's comments say "internals" where they said "rendering". The type gets a one-line comment, since its name doesn't say whose internals they are.
Guide example.
docs/writing-comments.mdquotes the function's comment as an example, so the quote is updated to match.Not changed. The symbol's registry string and the function's signature stay as they are. This is a rename only.