tl-its-umich-edu / canvas-app-explorer

A Web application that presents a list of Canvas external (LTI) tools with details. When integrated within Canvas, the user can search for specific LTI tool(s), and add or remove those tools from Canvas courses.
Apache License 2.0
4 stars 6 forks source link

Add more docstrings to python methods #169

Open jonespm opened 2 years ago

jonespm commented 2 years ago

Something I'd like to get better about (again) is using docstrings. I used these consistently in Java and more consistently in MyLA but I think not as much here. There's an extension for this but I'm not sure the format. to use. Sphinx and "one-line Sphnix" seem the most popular but Google looks easiest to read, though taking up more space.

We can go back and do this on another issue too, or start with this one!

_Originally posted by @jonespm in https://github.com/tl-its-umich-edu/canvas-app-explorer/pull/167#discussion_r877052126_