Add Notes Section #10
Closed
Conversation
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
Add 'important notes' property to function schema and update notes display. Refactor style on pages
…n on functions page
Fernando-A-Rocha
requested changes
May 19, 2025
| @@ -163,6 +171,10 @@ $defs: | |||
| description: | | |||
| The default value for this parameter, if none was given in the call to the function. | |||
| This property automatically implicitly marks this parameter as optional. | |||
| optional: | |||
There was a problem hiding this comment.
As I explained in the other PR #9 where you tried to implement this optional attribute, it is not needed.
Fernando-A-Rocha
requested changes
May 19, 2025
| @@ -43,6 +43,14 @@ $defs: | |||
| description: | |||
| type: string | |||
| description: Describes the functionality provided by the function. | |||
| important_notes: | |||
There was a problem hiding this comment.
I don't think a new attribute is needed. You should change the notes attribute by giving it more properties other than description like "type" so we can specify the "importance" or color of the note (like warning).
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.
This pull request introduces enhancements to the function schema, improves the rendering and styling of function pages, and refines the utility functions for handling function data. Key changes include the addition of new schema properties, the implementation of a reusable
NoteBoxcomponent, and updates to thegetFunctionInfoutility for better type definitions and data handling.Schema Enhancements:
important_notesfield to the function schema, which is an array of strings for capturing additional information about a function. (schemas/function.yamlschemas/function.yamlR46-R53)optionalboolean property for function parameters, indicating whether a parameter is optional. (schemas/function.yamlschemas/function.yamlR174-R177)UI Improvements:
NoteBoxcomponent for displaying styled notes on function pages. (web/src/components/NoteBox.astroweb/src/components/NoteBox.astroR1-R21)NoteBoxcomponent and added sections for notes and examples on function pages, improving content organization and readability. (web/src/pages/[func].astroweb/src/pages/[func].astroL22-R48, web/src/pages/[func].astroR57-R85)web/src/styles/function-page.cssweb/src/styles/function-page.cssR1-R26)Utility Function Enhancements:
getFunctionInfoto include new schema fields (important_notes,parameters) and improved type definitions for better maintainability. (web/src/utils/functions.tsweb/src/utils/functions.tsL36-R85)web/src/utils/functions.tsweb/src/utils/functions.tsL58-R106)