Blui 5309 rewrite jsdocs #375
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
ektaghag-eaton
requested review from
JeffGreiner-eaton,
surajeaton and
joebochill
as code owners
github-actions
bot
added
the
brightlayer-ui
…native-workflows into blui-5309-rewrite-jsdocs
joebochill
reviewed
Mar 1, 2024
manojleaton
reviewed
Mar 4, 2024
login-workflow/src/components/WorkflowCard/WorkflowCard.types.ts
Outdated
Show resolved
Hide resolved
login-workflow/src/components/WorkflowCard/WorkflowCardHeader.tsx
Outdated
Show resolved
Hide resolved
manojleaton
reviewed
Mar 4, 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.
Fixes # .
Changes proposed in this Pull Request:
Fixed following issues:
WorkflowCard and related types are not exported from the main index file…these need to be exported so they can be consumed by users who want to use variables to hold some of their configuration properties.
Incorrect use of @param
Missing annotations for top-level type definitions
Misplaced annotations. E.g., here the annotation for the BasicDialog component is not next to the BasicDialog component definition:
Missing annotations on various components, e.g., PasswordRequirements:
Missing annotations on various screens, e.g., CreatePasswordScreenBase
Missing annotations on ContextProvider components that will be used by adopters directly, e.g., RegistrationWorkflowContextProvider
Incorrect Component annotation format / duplicated comments/definitions, e.g., AccountDetailsScreenBase, SuccessScreenBase:
Screenshots / Screen Recording (if applicable)
To Test:
Any specific feedback you are looking for?