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.

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

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

Conversation

ggsawatyanon
Copy link
Contributor

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.

  • Removed CantFindApartmentModal.ts (an unused component)
  • Updated DropDown.tsx and DropDownWithLabel.tsx documentation for clarity
  • Added documentation for HomeConsts.ts

Test Plan

@dti-github-bot
Copy link
Member

dti-github-bot commented Feb 9, 2025

[diff-counting] Significant lines: 61.

Copy link
Contributor

@CasperL1218 CasperL1218 left a 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.

Copy link
Contributor

@parsa-tehranipoor parsa-tehranipoor left a 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.

@kea-roy
Copy link
Member

kea-roy commented Feb 16, 2025

PR Changes

  • Updated DropDownWithLabel documentation to match new standard
  • Updated DropDown documentation to match new standard

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants