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

API signatures should only appear in auto-generated API DOCS #1213

Open
amessbee opened this issue Sep 25, 2024 · 1 comment
Open

API signatures should only appear in auto-generated API DOCS #1213

amessbee opened this issue Sep 25, 2024 · 1 comment
Labels
api-docs issues that generated api-docs should address documentation

Comments

@amessbee
Copy link
Contributor

amessbee commented Sep 25, 2024 •
edited
Loading

Engineering raised the concern that orchestration function signatures should not be manually added to the documentation. This results in extra effort to maintain them as future changes in API signatures won't be directly reflected in documentation. Rather, these should only appear in API docs generated by TypeDoc.

Refs:
@amessbee
Copy link
Contributor Author

@mujahidkay can you please add ref to discussion regarding scheduled update of API docs.

@amessbee amessbee added documentation api-docs issues that generated api-docs should address labels Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
api-docs issues that generated api-docs should address documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@amessbee