Skip to content

Missing Inline Documentation #755

@melgu

Description

@melgu

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions