-
Notifications
You must be signed in to change notification settings - Fork 3
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.
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
Add HomeConst.ts documentation #388
base: main
Are you sure you want to change the base?
Conversation
[diff-counting] Significant lines: 61. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The documentation for frontend/src/constants/HomeConsts.ts
is clear and informative.
One possible change is to update the DropDown
component's documentation, which currently does not follow our new documentation guideline. For instance, the current documentation did not provide specification for all four parameters.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The movement of documentation is great for clarity and organization, and the added documentation follows our guidelines. I agree with Casper's request for changes on the documentation for the DropDownWithLabel component, as it seems to be outdated.
PR Changes
|
Summary
This pull request cleans up the code base by removing a redundant and unused component (CantFindApartmentModal.ts), moves the documentation for DropDown and DropDownWithLabel to above the function declaration for clarity, and adds documentation for HomeConsts.ts.
Test Plan