docs(methods): update component method documentation #4145#30495
Merged
brandyscarney merged 28 commits intoionic-team:mainfrom Jun 26, 2025
Merged
docs(methods): update component method documentation #4145#30495brandyscarney merged 28 commits intoionic-team:mainfrom
brandyscarney merged 28 commits intoionic-team:mainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Member
|
Can we open this against the |
Contributor
Author
|
@brandyscarney yes, should I make a new pull request to the main branch? |
Member
|
@soundproofboot You can edit the branch on this PR by pressing "Edit" next to the PR title - but you may have to update your branch if you created it off of |
brandyscarney
requested changes
Jun 23, 2025
Member
brandyscarney
left a comment
brandyscarney
left a comment
There was a problem hiding this comment.
Looks good! Just some minor requests. 🙂
Co-authored-by: Brandy Smith <brandyscarney@users.noreply.github.com>
Co-authored-by: Brandy Smith <brandyscarney@users.noreply.github.com>
Co-authored-by: Brandy Smith <brandyscarney@users.noreply.github.com>
Co-authored-by: Brandy Smith <brandyscarney@users.noreply.github.com>
Co-authored-by: Brandy Smith <brandyscarney@users.noreply.github.com>
Co-authored-by: Brandy Smith <brandyscarney@users.noreply.github.com>
Co-authored-by: Brandy Smith <brandyscarney@users.noreply.github.com>
Co-authored-by: Brandy Smith <brandyscarney@users.noreply.github.com>
Co-authored-by: Brandy Smith <brandyscarney@users.noreply.github.com>
Co-authored-by: Brandy Smith <brandyscarney@users.noreply.github.com>
Co-authored-by: Brandy Smith <brandyscarney@users.noreply.github.com>
brandyscarney
approved these changes
Jun 23, 2025
Member
brandyscarney
left a comment
brandyscarney
left a comment
There was a problem hiding this comment.
Looks good, thank you!! 👍
thetaPC
requested changes
Jun 26, 2025
Contributor
thetaPC
left a comment
thetaPC
left a comment
There was a problem hiding this comment.
Minor requests to keep consistency among the param structure.
Co-authored-by: Maria Hutt <thetaPC@users.noreply.github.com>
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
3 participants
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.
Issue number: resolves ionic-team/ionic-docs#4145
What is the current behavior?
Some component methods are missing param tags in the JSDoc comments. Some comments are out of order and the method description is below the last param description. Some back ticks are misplaced around words resulting in incorrect formatting in the docs site.
What is the new behavior?
Method documentation in app, action-sheet, alert, datetime, loading, menu, modal, popover, reorder-group, router, searchbar, and toast now include descriptions for all params, all method descriptions are placed above param descriptions, and back ticks are formatted correctly. All changes are within JSDoc comments so will result in a change to the docs site but no functional change to any components.
Does this introduce a breaking change?
Other information
In order to preview these changes I took the JSON generated from the build on this branch and used it in the docusaurus script in place of the fetch from unpkg. I set up a preview from my fork on Vercel - https://ionic-docs-git-temptotestdocs-soundproofboots-projects.vercel.app/docs/components . The change I made to the docusaurus script to use this temp data is here - https://github.com/soundproofboot/ionic-docs/pull/1/files. tempDocs.json is the output of the framework build after making these changes.