More text in route

[peterdudfield]

Add more text in each route.

It should clear example what the route does and what the extra variables do

[peterdudfield]

Could be done both by @dctanner and @rachel-labri-tipton

[rachel-labri-tipton]

Thanks. Are these the route descriptions found here?

I'll try to have a look at the current route descriptions before our check-in tomorrow.

@dctanner, let me know if you have a moment this week to look at this together.

[peterdudfield]

Thanks @rachel-labri-tipton . They are all in the code, but there's a nice way to see them.

Go to the api docs
Which look a bit like this

[peterdudfield]

context: #131

[peterdudfield]

General info is here

each route info is here

[peterdudfield]

using pydoc google style https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html

[peterdudfield]

I have discussed this with @rachel-labri-tipton (thanks) and she is going to have a go at this. I'm happy to help support with any things that dont make sense.

We also found a nice thing where you can write 'markdown' code into the descriptions. This helps make formating things really nice

[rachel-labri-tipton]

hi @peterdudfield, if you by chance have a moment today, would you be able to add/invite me to this repository? I'm trying to push to the new branch I created, and it says permission denied. Thanks!

I can also wait until tomorrow to push my work.

[peterdudfield]

hi @rachel-labri-tipton . I've invited you to the repo, so hopefully you can do a new branch