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

The endpoint macros documentation should point to the module endpoint #670

Closed
cafce25 opened this issue Feb 1, 2024 · 0 comments · Fixed by #671
Closed

The endpoint macros documentation should point to the module endpoint #670

cafce25 opened this issue Feb 1, 2024 · 0 comments · Fixed by #671

Comments

@cafce25
Copy link

cafce25 commented Feb 1, 2024

Describe the bug
When we look at the documentation for the macro endpoint there isn't a whole lot to be seen, when it should have information about how it can be used, there is also no indication where else such information can be found.

Expected behavior
The documentation of endpoint! should be easily discoverable from it's documentation page.

Additional context
The documentation is acutally available, on the documentation page for the module endpoint so an easy fix would be to just link to it from the macros page something along the lines of

/// See the [module level documentation](mod@endpoint)

before the macros definition.

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 a pull request may close this issue.

1 participant