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

Missing Inline Documentation #755

Open
melgu opened this issue Jan 19, 2023 · 0 comments
Open

Missing Inline Documentation #755

melgu opened this issue Jan 19, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@melgu
Copy link

melgu commented Jan 19, 2023

Is your feature request related to a problem? Please describe.
Currently, there is basically no inline documentation. This means, instead of just alt-clicking the function in question, I have to always search the vapor documentation website, which doesn't cover everything.

Describe the solution you'd like
Each function should be covered with documentation, just like in the main vapor package.

Describe alternatives you've considered
https://docs.vapor.codes/fluent/overview/ already exists, but it fulfills a different purpose to inline documentation. It is more like a tutorial, while the inline documentation serves as a reference with examples.

Additional context
Here's an example of how the "documentation" for the fluent query filter looks inside Xcode:
fluent filter

For contrast, here's an example from the main vapor package:
vapor redirect

@melgu melgu added the enhancement New feature or request label Jan 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant