vapor / fluent

Vapor ORM (queries, models, and relations) for NoSQL and SQL databases
https://docs.vapor.codes/4.0/fluent/overview/
MIT License
1.3k stars 171 forks source link

Missing Inline Documentation #755

Open melgu opened 1 year ago

melgu commented 1 year ago

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