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

Add doc strings to module handlers #3286

Merged
merged 4 commits into from
May 17, 2021
Merged

Add doc strings to module handlers #3286

merged 4 commits into from
May 17, 2021

Conversation

willgearty
Copy link
Member

I ensured that every module handler had a doc string. These are mostly used on the /main management page, so only mostly useful for management modules, but this at least gives us the option to use them in more places in the future.

I also alphabetized the "Additional Modules" list on the /main management page.

Fixes #3088.

Copy link
Contributor

@hwatheod hwatheod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for writing this documentation! Most suggested changes are removing leading and trailing spaces, with a few other minor things.

esp/esp/program/modules/handlers/surveymanagement.py Outdated Show resolved Hide resolved
esp/esp/program/modules/handlers/teacherpreviewmodule.py Outdated Show resolved Hide resolved
esp/esp/program/modules/handlers/teacherbiomodule.py Outdated Show resolved Hide resolved
esp/esp/program/modules/handlers/teachersurveymodule.py Outdated Show resolved Hide resolved
esp/esp/program/modules/handlers/unenrollmodule.py Outdated Show resolved Hide resolved
esp/esp/program/modules/handlers/mapgenmodule.py Outdated Show resolved Hide resolved
esp/esp/program/modules/handlers/nametagmodule.py Outdated Show resolved Hide resolved
esp/esp/program/modules/handlers/studentextracosts.py Outdated Show resolved Hide resolved
esp/esp/program/modules/handlers/studentregconfirm.py Outdated Show resolved Hide resolved
esp/esp/program/modules/handlers/studentsurveymodule.py Outdated Show resolved Hide resolved
willgearty and others added 2 commits May 17, 2021 11:33
Co-authored-by: hwatheod <ted@learningu.org>
@willgearty willgearty requested a review from hwatheod May 17, 2021 16:35
Copy link
Contributor

@hwatheod hwatheod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@willgearty willgearty merged commit 4bba497 into main May 17, 2021
@willgearty willgearty deleted the module-docs branch May 17, 2021 20:09
willgearty added a commit that referenced this pull request May 18, 2021
willgearty added a commit that referenced this pull request May 27, 2021
* Initial docs for stable release 13

* Docs for #3116, #3117, and #3118

* Added docs about django upgrade

* Docs for #3128

* Docs for #3129, #3133, #3134, and #3137

* Docs for #3156 and #3153

* Docs for #3174, #3163, and #3184

* Docs for #3139, #3140, and #3141

* Docs for #3143, #3150, #3154, #3160, #3162, and #3168

* Docs for #3171, #3185, #3186, and #3188

* Docs for #3131 and #3189

* Docs for #3149 and #3190

* Docs for #3193, #3194, #3195, #196, and #3197

* Clarification

* Docs for #3192, #3201, #3209, and #2248

* Docs for #3204, #3212, #3214, #3205, 9fd073c, and #3226

* Docs for #3232, de5861c, #3231, #3233, #3234, #3237, #3238, and #3239

* Fix indent

* Docs for #3227 and #3235

* Add missing word

* spelling

* Docs for e57581f, #3255, #3253, #3257, and #3249

* Docs for #3254, #3260, and #3262

* Docs for #3263, #3272, #3240, #3264, #3266, and #3270

* clarifications

* Docs for #3283 and #3252

* Docs for #3288 and misc commits

* Docs for #3292, #3311, #3286, #3289, and #3279

* Docs for a377f0d; move note

* Docs for #3315, #3290, and #3322

* Docs for #3273 and #3317

* Final edits
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

More management modules should have doc strings
2 participants