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

Documentation issue for pipe method #140

Closed
vitaly-t opened this issue Oct 5, 2022 · 2 comments
Closed

Documentation issue for pipe method #140

vitaly-t opened this issue Oct 5, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@vitaly-t
Copy link
Owner

vitaly-t commented Oct 5, 2022

PR #132 created a problem for generating documentation.

@RebeccaStevens You changed pipe signature from function to const, and typedoc cannot pick it up correctly anymore, the pipe is altogether skipped from documentation, which in turn results in unresolved links.

You can check for errors by running npm run doc.

@vitaly-t vitaly-t added the documentation Improvements or additions to documentation label Oct 5, 2022
@vitaly-t
Copy link
Owner Author

vitaly-t commented Oct 6, 2022

Also, I noticed that for some methods, you copied inline documentation for sync + async. I'm not sure I see the benefit of it, duplicating documentation. Plus that extra category Async, in addition to already sufficient Async-Only.

I think it is simpler to keep just one documentation block per operator, and leave as Sync+Async category by default.

@vitaly-t
Copy link
Owner Author

This has been resolved, closing now.

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

No branches or pull requests

1 participant