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

Fix bad formatting in API docs #101

Closed
AdrianDAlessandro opened this issue Jul 13, 2023 · 0 comments · Fixed by #108
Closed

Fix bad formatting in API docs #101

AdrianDAlessandro opened this issue Jul 13, 2023 · 0 comments · Fixed by #108
Assignees
Labels
bug Something isn't working
Milestone

Comments

@AdrianDAlessandro
Copy link
Collaborator

AdrianDAlessandro commented Jul 13, 2023

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:

  1. Go to http://liionsden.rcs.ic.ac.uk/docs
  2. View the formatting of the docs under each API

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 markdown

Aha! Link: https://imperial-college-ict.aha.io/requirements/RSE-141-24

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants