Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor JSDoc @see references #10083

Open
1 of 2 tasks
geospatialem opened this issue Aug 15, 2024 · 1 comment
Open
1 of 2 tasks

Refactor JSDoc @see references #10083

geospatialem opened this issue Aug 15, 2024 · 1 comment
Labels
0 - new New issues that need assignment. docs Issues relating to documentation updates only. estimate - 5 A few days of work, definitely requires updates to tests. needs milestone Planning workflow - pending milestone assignment, has priority and/or estimate. p - medium Issue is non core or affecting less that 60% of people using the library

Comments

@geospatialem
Copy link
Member

geospatialem commented Aug 15, 2024 •
edited
Loading

Description

There are @see JSDoc references across many different components, however their context is not updated on our doc site.

Instead we should seek alternative approaches, such as providing the links using markdown to providing the context, or seek opportunities of improvement through the documentation site, etc.

Which Component

Verify across components

Resources

  • 1. Phase I:
    • Cleanup see to @see
      • URL references were formatted to markdown markup for phase II (e.g., [A link text](a-url-link))
  • 2. Phase II:
    • Add conditionals to display the @see references in the documentation site with markdown markup
@geospatialem geospatialem added docs Issues relating to documentation updates only. 0 - new New issues that need assignment. p - medium Issue is non core or affecting less that 60% of people using the library estimate - 5 A few days of work, definitely requires updates to tests. labels Aug 15, 2024
@geospatialem geospatialem added 1 - assigned Issues that are assigned to a sprint and a team member. and removed 0 - new New issues that need assignment. labels Sep 13, 2024
@geospatialem geospatialem self-assigned this Sep 13, 2024
@geospatialem geospatialem mentioned this issue Dec 23, 2024
Merged
@geospatialem geospatialem added 2 - in development Issues that are actively being worked on. and removed 1 - assigned Issues that are assigned to a sprint and a team member. labels Dec 23, 2024
geospatialem added a commit that referenced this issue Dec 27, 2024
@geospatialem
docs: add jsdoc @see tag consistency (#11140)
61b58b6 
**Related Issue:** #10083 

## Summary
Add consistent use of the `@see` JSDoc references across the repo, where
previously there was a mix of `see` and `@see` references.

This is phase 1 of 2 for the issue, where phase 2 will require
documentation updates to accommodate the JSDoc references to display on
the site.
@geospatialem
Copy link
Member Author

Phase I above is complete, for the doc-related site updates think we could work on this effort for February and/or early March. Unassigning myself for the effort - @DitwanP would you have capacity to take the second part of this effort on the doc site in February?

@geospatialem geospatialem added 0 - new New issues that need assignment. and removed 2 - in development Issues that are actively being worked on. labels Jan 3, 2025
@geospatialem geospatialem removed their assignment Jan 3, 2025
benelan pushed a commit that referenced this issue Feb 8, 2025
@geospatialem @benelan
docs: add jsdoc @see tag consistency (#11140)
2213158 
**Related Issue:** #10083 

## Summary
Add consistent use of the `@see` JSDoc references across the repo, where
previously there was a mix of `see` and `@see` references.

This is phase 1 of 2 for the issue, where phase 2 will require
documentation updates to accommodate the JSDoc references to display on
the site.
@geospatialem geospatialem added the needs milestone Planning workflow - pending milestone assignment, has priority and/or estimate. label Feb 24, 2025
@brittneytewks brittneytewks removed this from the Dev Backlog milestone Feb 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
0 - new New issues that need assignment. docs Issues relating to documentation updates only. estimate - 5 A few days of work, definitely requires updates to tests. needs milestone Planning workflow - pending milestone assignment, has priority and/or estimate. p - medium Issue is non core or affecting less that 60% of people using the library
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@geospatialem @brittneytewks