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

Clean up and document interfaces exposed to users #181

Closed
hackerwins opened this issue Apr 21, 2021 · 0 comments · Fixed by #218 or #219
Closed

Clean up and document interfaces exposed to users #181

hackerwins opened this issue Apr 21, 2021 · 0 comments · Fixed by #218 or #219
Assignees
Labels
cleanup 🧹 Paying off technical debt documentation 📔 Improvements or additions to documentation

Comments

@hackerwins
Copy link
Member

Description:

Clean up and document interfaces exposed to users.

At #173 we only exposed documents that are exposed to the user. After doing this, we find that fewer comments are written in the interfaces exposed to the user.

Let's check the items below:

  • Comment the interfaces exposed to the user
  • Add @internal to expose unnecessary interfaces
  • Add @public to the interfaces we need to expose but are missing and export them in the entry file.

Why:

Users experience the product through the interfaces. Therefore, it is very important to clean up the exposed interfaces.

@hackerwins hackerwins added documentation 📔 Improvements or additions to documentation cleanup 🧹 Paying off technical debt labels Apr 21, 2021
@mojosoeun mojosoeun self-assigned this Jun 5, 2021
@mojosoeun mojosoeun mentioned this issue Jun 27, 2021
2 tasks
mojosoeun added a commit that referenced this issue Jul 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup 🧹 Paying off technical debt documentation 📔 Improvements or additions to documentation
Projects
None yet
2 participants