You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Describe the bug
The API docs do not display in a clear and readable way. Also the title for the docs is still FastAPI - this should be changed to Gridlington and a little preamble included.
Describe the bug
The API docs do not display in a clear and readable way. Also the title for the docs is still FastAPI - this should be changed to Gridlington and a little preamble included.
To Reproduce
Steps to reproduce the behavior:
Expected behavior
I expected the FastAPI docs to respect the Google docstring style but they do not.
Additional context
FastAPI docs render the entire docstring as markdown, including the parameters definitions. The docstrings for the api functions need to be updated to include a brief description, followed by and escaped form feed character
\f
to not render the parameters as markdownAha! Link: https://imperial-college-ict.aha.io/requirements/RSE-141-24
The text was updated successfully, but these errors were encountered: