Spec for Extension Types proposal #259
Merged
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
|
CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅ |
|
Warning Rate limit exceeded@ZverGuy has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 31 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughThe new specification for extension types in the Vein Language enables developers to augment existing types with enhanced functionality. It delineates explicit and implicit extension declarations, offering comprehensive guidelines on syntax, member declarations, and parser implementation to boost code functionality and maintainability. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
5 tasks
|
I have read the CLA Document and I hereby sign the CLA |
code-maid
added a commit
that referenced
this pull request
Aug 2, 2024
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (2)
specs/extension_types.md (2)
34-87: Specify the language for fenced code blocks.To improve readability and comply with Markdownlint rules, specify the language for fenced code blocks.
- ``` + ```ebnf<details> <summary>Tools</summary> <details> <summary>Markdownlint</summary><blockquote> 40-40: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 58-58: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 66-66: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 81-81: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </details> --- `89-139`: **Specify the language for fenced code blocks.** To improve readability and comply with Markdownlint rules, specify the language for fenced code blocks. ```diff - ``` + ```ebnf<details> <summary>Tools</summary> <details> <summary>Markdownlint</summary><blockquote> 95-95: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 105-105: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 115-115: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 125-125: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 135-135: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </details> </blockquote></details> </blockquote></details> <details> <summary>Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** <details> <summary>Commits</summary> Files that changed from the base of the PR and between d620496a8a704f293c024408d45dab6f3c56a6ff and 92552e9b859b5a0edf00155a98f93bc852af15b6. </details> <details> <summary>Files selected for processing (1)</summary> * specs/extension_types.md (1 hunks) </details> <details> <summary>Additional context used</summary> <details> <summary>LanguageTool</summary><blockquote> <details> <summary>specs/extension_types.md</summary><blockquote> [style] ~147-~147: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. Context: ...it extensions (optional). - `extension` keyword to introduce the extension. ### Extens... (ENGLISH_WORD_REPEAT_BEGINNING_RULE) </blockquote></details> </blockquote></details> <details> <summary>Markdownlint</summary><blockquote> <details> <summary>specs/extension_types.md</summary><blockquote> 40-40: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 58-58: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 66-66: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 81-81: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 95-95: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 105-105: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 115-115: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 125-125: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 135-135: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </blockquote></details> </details> <details> <summary>Additional comments not posted (7)</summary><blockquote> <details> <summary>specs/extension_types.md (7)</summary><blockquote> `3-6`: **LGTM!** The introduction is clear and concise. --- `7-10`: **LGTM!** The explanation of extension declarations is clear and concise. --- `11-15`: **LGTM!** The explanation of explicit and implicit extensions is clear and concise. --- `141-163`: **LGTM!** The parsing procedures are clear and concise. <details> <summary>Tools</summary> <details> <summary>LanguageTool</summary><blockquote> [style] ~147-~147: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. Context: ...it extensions (optional). - `extension` keyword to introduce the extension. ### Extens... (ENGLISH_WORD_REPEAT_BEGINNING_RULE) </blockquote></details> </details> --- `165-180`: **LGTM!** The example parsing implementation is clear and concise. --- `182-201`: **LGTM!** The example extension declarations are clear and concise. --- `203-205`: **LGTM!** The conclusion is clear and concise. </blockquote></details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
0xF6
requested changes
Aug 2, 2024
remove lang colorizing
fix shit Co-authored-by: Yuuki Wesp <ls-micro@ya.ru>
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (18)
specs/extension_types.md (18)
40-42: Specify the language for fenced code blocks.To improve readability and comply with markdownlint rules, specify the language for fenced code blocks.
-``` +```ebnf<details> <summary>Tools</summary> <details> <summary>Markdownlint</summary><blockquote> 40-40: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </details> --- `58-60`: **Specify the language for fenced code blocks.** To improve readability and comply with markdownlint rules, specify the language for fenced code blocks. ```diff -``` +```ebnf<details> <summary>Tools</summary> <details> <summary>Markdownlint</summary><blockquote> 58-58: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </details> --- `66-75`: **Specify the language for fenced code blocks.** To improve readability and comply with markdownlint rules, specify the language for fenced code blocks. ```diff -``` +```ebnf<details> <summary>Tools</summary> <details> <summary>Markdownlint</summary><blockquote> 66-66: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </details> --- `81-87`: **Specify the language for fenced code blocks.** To improve readability and comply with markdownlint rules, specify the language for fenced code blocks. ```diff -``` +```ebnf<details> <summary>Tools</summary> <details> <summary>Markdownlint</summary><blockquote> 81-81: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </details> --- `95-99`: **Specify the language for fenced code blocks.** To improve readability and comply with markdownlint rules, specify the language for fenced code blocks. ```diff -``` +```ebnf<details> <summary>Tools</summary> <details> <summary>Markdownlint</summary><blockquote> 95-95: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </details> --- `105-109`: **Specify the language for fenced code blocks.** To improve readability and comply with markdownlint rules, specify the language for fenced code blocks. ```diff -``` +```ebnf<details> <summary>Tools</summary> <details> <summary>Markdownlint</summary><blockquote> 105-105: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </details> --- `115-119`: **Specify the language for fenced code blocks.** To improve readability and comply with markdownlint rules, specify the language for fenced code blocks. ```diff -``` +```ebnf<details> <summary>Tools</summary> <details> <summary>Markdownlint</summary><blockquote> 115-115: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </details> --- `125-129`: **Specify the language for fenced code blocks.** To improve readability and comply with markdownlint rules, specify the language for fenced code blocks. ```diff -``` +```ebnf<details> <summary>Tools</summary> <details> <summary>Markdownlint</summary><blockquote> 125-125: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </details> --- `135-139`: **Specify the language for fenced code blocks.** To improve readability and comply with markdownlint rules, specify the language for fenced code blocks. ```diff -``` +```ebnf<details> <summary>Tools</summary> <details> <summary>Markdownlint</summary><blockquote> 135-135: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </details> --- `143-148`: **Reword sentences to avoid repetition.** To improve readability and comply with LanguageTool suggestions, reword the sentences to avoid repetition. ```diff -`explicit` keyword for explicit extensions (optional). -`implicit` keyword for implicit extensions (optional). -`extension` keyword to introduce the extension. +Use the `explicit` keyword for explicit extensions (optional). +Use the `implicit` keyword for implicit extensions (optional). +Use the `extension` keyword to introduce the extension.Tools
LanguageTool
[style] ~147-~147: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...it extensions (optional). -extensionkeyword to introduce the extension. ### Extens...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
171-171: Incorporate previous suggestions.To improve readability and follow best practices, incorporate the previous suggestions.
-from modifiers in ExtensionModifiers.Token().Many() +from modifiers in Modifier.Token().Many()
172-172: Incorporate previous suggestions.To improve readability and follow best practices, incorporate the previous suggestions.
-from keyword in Parse.String("extension").Token() +from keyword in KeyworkExpression("extension").Token()
174-174: Incorporate previous suggestions.To improve readability and follow best practices, incorporate the previous suggestions.
-from typeParams in TypeParameterList.Token().Optional() +from typeParams in GenericsDeclarationParser.Token().Optional()
175-175: Incorporate previous suggestions.To improve readability and follow best practices, incorporate the previous suggestions.
-from forKeyword in Parse.String("for").Token().Optional() +from forKeyword in KeyworkExpression("for").Token().Optional()
177-177: Incorporate previous suggestions.To improve readability and follow best practices, incorporate the previous suggestions.
-from constraints in TypeParameterConstraintsClause.Token().Many().Optional() +from constraints in GenericConstraintParser.Token().Many().Optional()
178-178: Incorporate previous suggestions.To improve readability and follow best practices, incorporate the previous suggestions.
-from body in ExtensionBody.Token() +from body in ClassMemberDeclaration.Token()
186-193: Specify the language for fenced code blocks.To improve readability and comply with markdownlint rules, specify the language for fenced code blocks.
-``` +```csharp<details> <summary>Tools</summary> <details> <summary>Markdownlint</summary><blockquote> 186-186: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </details> --- `197-201`: **Specify the language for fenced code blocks.** To improve readability and comply with markdownlint rules, specify the language for fenced code blocks. ```diff -``` +```csharp<details> <summary>Tools</summary> <details> <summary>Markdownlint</summary><blockquote> 197-197: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </details> </blockquote></details> </blockquote></details> <details> <summary>Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** <details> <summary>Commits</summary> Files that changed from the base of the PR and between 92552e9b859b5a0edf00155a98f93bc852af15b6 and d810e27f900c4c5954267d48d21f787a49d23f7a. </details> <details> <summary>Files selected for processing (1)</summary> * specs/extension_types.md (1 hunks) </details> <details> <summary>Additional context used</summary> <details> <summary>LanguageTool</summary><blockquote> <details> <summary>specs/extension_types.md</summary><blockquote> [style] ~147-~147: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. Context: ...it extensions (optional). - `extension` keyword to introduce the extension. ### Extens... (ENGLISH_WORD_REPEAT_BEGINNING_RULE) </blockquote></details> </blockquote></details> <details> <summary>Markdownlint</summary><blockquote> <details> <summary>specs/extension_types.md</summary><blockquote> 40-40: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 58-58: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 66-66: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 81-81: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 95-95: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 105-105: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 115-115: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 125-125: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 135-135: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 186-186: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 197-197: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </blockquote></details> </details> <details> <summary>Additional comments not posted (4)</summary><blockquote> <details> <summary>specs/extension_types.md (4)</summary><blockquote> `3-5`: **LGTM!** The introduction section is clear and concise. --- `7-9`: **LGTM!** The extension declaration section is clear and concise. --- `11-14`: **LGTM!** The explicit vs implicit extensions section is clear and concise. --- `203-205`: **LGTM!** The conclusion section is clear and concise. </blockquote></details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
fix example 3 Co-authored-by: Yuuki Wesp <ls-micro@ya.ru>
changes Co-authored-by: Yuuki Wesp <ls-micro@ya.ru>
update spec Co-authored-by: Yuuki Wesp <ls-micro@ya.ru>
apply Co-authored-by: Yuuki Wesp <ls-micro@ya.ru>
Co-authored-by: Yuuki Wesp <ls-micro@ya.ru>
Co-authored-by: Yuuki Wesp <ls-micro@ya.ru>
code-maid
approved these changes
Aug 2, 2024
0xF6
approved these changes
Aug 2, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
fix issue #255
Summary by CodeRabbit