search

bocadilloproject / bocadillo

(UNMAINTAINED) Fast, scalable and real-time capable web APIs for everyone
https://bocadilloproject.github.io
MIT License
396 stars 41 forks source link

API reference documentation #316

Closed sodrooome closed 5 years ago

sodrooome commented 5 years ago

Is your feature request related to a problem? Please describe. when I read the API reference documentation in the application.py section, there seems to be a sentence that has not been linked to the websocket section/guide.

Describe the solution you'd like it might be better if the documentation is corrected.

Describe alternatives you've considered NA

Implementation ideas Unfortunately, I don't know whether it's a typo or not 😄

Additional context NA

florimondmanca commented 5 years ago

Hi! Thanks for reporting this. I noticed there was a strange-looking "::bocadillo.websockets#WebSocket" in .add_websocket_route(), is this what you were referring to? I pushed a fix in #317. :-)

There are probably other examples of this which are caused by a change in pydocmd (the library used to convert docstrings to Markdown files).

If you see more, feel free to try and fix them based on the example in #317 😄

The format for links to the API documentation is "/api/.md". For the guide, it is "/guide/.md" ( being one of the Markdown files in docs/guide).

sodrooome commented 5 years ago

yes, I noticed that too!

thank you for the answer and response, i'll try to fix it when I find something like that again

florimondmanca commented 5 years ago

Sounds good! Since the original problem has been solved I'll close this. :-)