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

frontend: write documentation for frontend functions and data structures #2842

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

frontend: write documentation for frontend functions and data structures #2842

wants to merge 5 commits into from

Conversation

Jineshbansal
Copy link

Fixes: #976

Functions and data structures documented:

  • headlamp/frontend/src/i18n/ThemeProviderNexti18n.tsx@ThemeProviderNexti18n
  • headlamp/frontend/src/i18n/LocaleSelect/LocaleSelect.tsx@LocaleSelectProps
  • headlamp/frontend/src/components/common/Tabs.tsx@TabsProps

@dosubot dosubot bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Feb 4, 2025
@Jineshbansal Jineshbansal force-pushed the chore/add-tsdoc-comments branch from 59b026a to c733365 Compare February 4, 2025 18:25
@illume
Copy link
Collaborator

illume commented Feb 7, 2025

Hello :)

Thanks for this. The CI job is reporting an error.

The code could be formatted with:
npm run format

headlamp@0.1.0 format-check
prettier --config package.json --check --cache src ../app/electron ../app/tsconfig.json ../app/scripts ../plugins/headlamp-plugin/bin ../plugins/headlamp-plugin/config ../plugins/headlamp-plugin/template ../plugins/headlamp-plugin/test*.js ../plugins/headlamp-plugin/.json ../plugins/headlamp-plugin/.js

Checking formatting...
[warn] src/i18n/LocaleSelect/LocaleSelect.tsx
[warn] src/i18n/ThemeProviderNexti18n.tsx
[warn] Code style issues found in 2 files. Forgot to run Prettier?
make: *** [Makefile:113: frontend-lint] Error 1

illume
illume requested changes Feb 7, 2025
View reviewed changes
Copy link
Collaborator

@illume illume left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some notes about formatting issue to address with the types in the param docs.

skoeva
skoeva reviewed Feb 7, 2025
View reviewed changes
Copy link
Contributor

@skoeva skoeva left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Echoing the comments above, just a reminder to run the linter to pass the CI:

make frontend-lint

@Jineshbansal Jineshbansal force-pushed the chore/add-tsdoc-comments branch 2 times, most recently from 67d7a6a to 0820381 Compare February 17, 2025 17:54
@Jineshbansal
Copy link
Author

Jineshbansal commented Feb 17, 2025 •
edited
Loading

@illume removed the types in the comments

@Jineshbansal Jineshbansal requested a review from illume February 20, 2025 10:14
@Jineshbansal Jineshbansal force-pushed the chore/add-tsdoc-comments branch from 0820381 to f08a522 Compare February 20, 2025 10:14
@Jineshbansal Jineshbansal force-pushed the chore/add-tsdoc-comments branch from f08a522 to b5c6652 Compare February 21, 2025 18:18
@Jineshbansal
frontend: tsdocs: Add TSDoc comments to Tabs.tsx
159d4cb 
Signed-off-by: Jineshbansal <732005jinesh@gmail.com>
@Jineshbansal
frontend: tsdocs: Add TSDoc comments to LocaleSelect.tsx
a189800 
Signed-off-by: Jineshbansal <732005jinesh@gmail.com>
@Jineshbansal
frontend: tsdocs: Add TSDoc comments to ThemeProviderNexti18n.tsx
4d21de7 
Signed-off-by: Jineshbansal <732005jinesh@gmail.com>
@Jineshbansal
frontend: tsdocs: remove types in comments from ThemeProviderNexti18n…
ca97604 
….tsx and LocaleSelect.tsx

Signed-off-by: Jineshbansal <732005jinesh@gmail.com>
@Jineshbansal
frontend: tsdocs: correct the tsdoc style comments for fields
60cc7ef 
Signed-off-by: Jineshbansal <732005jinesh@gmail.com>
@Jineshbansal Jineshbansal force-pushed the chore/add-tsdoc-comments branch from b5c6652 to 60cc7ef Compare February 21, 2025 18:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@illume illume illume requested changes

@skoeva skoeva skoeva left review comments

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
size:M This PR changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

documentation for 'frontend' functions and data structures
3 participants
@Jineshbansal @illume @skoeva