igorbenav / fastcrud

FastCRUD is a Python package for FastAPI, offering robust async CRUD operations and flexible endpoint creation utilities.
MIT License
644 stars 45 forks source link

Correct links to advanced filters in docstrings? #128

Closed slaarti closed 2 months ago

slaarti commented 2 months ago

Description

(Possibly?) corrected relative links from fast_crud.py's docstrings to the section of the docs covering advanced filters.

Changes

This is a possible correction to #124: mkdocs complains about not recognizing the relative links' destination. The recommendation it provides didn't quite make sense to me relative to the URL structure as rendered, but it apparently automatically substituted it in and it appeared to work, so I just left them as I'd written them.

Now, I realize now that it may be more about the actual structure of the filesystem getting from api/fastcrud.md (which contains the includes from the code's docstrings) to advanced/crud.md, and mkdocs handles translating the file paths to URLs. So I put this PR together to fix the links and you can figure out whether or not it needs to go in. :D

Tests

No changes.

Checklist

Additional Notes

As noted above, I'm not 100% certain just how correct/needed this is; I'm pretty sure, since mkdocs has stopped complaining, but the links in the rendered pages worked either way and I can't tell if that's because it doesn't matter or just that mkdocs is cleverer than I am and was covering for my mistakes.