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

Improve documentation for users app #1292

Merged
merged 14 commits into from
Jun 25, 2024

Conversation

Samwalton9
Copy link
Member

@Samwalton9 Samwalton9 commented May 10, 2024

Updated and expanded documentation for the users app. This PR also includes some minor tidying of unused variables.

Where changes were more than documentation changes or might have been confusing I made individual commits to aid with review.

Phabricator Ticket

T264425

How Has This Been Tested?

Tests passed, and did some clicking around locally. I tested the Authorization admin page because I was especially unsure about that code removal.

Types of changes

What types of changes does your code introduce? Add an x in all the boxes that apply:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Minor change (fix a typo, add a translation tag, add section to README, etc.)

Copy link
Contributor

@katydidnot katydidnot left a comment

Choose a reason for hiding this comment

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

Thanks for your work updating documentation, this will be very helpful for me and other new team members.

I had one minor nit, but feel free to ignore.

Returns
----------
Queryset
A queryset of user objects
Copy link
Contributor

Choose a reason for hiding this comment

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

minor nit: QuerySet instead of Queryset for consistency.

Copy link
Contributor

@suecarmol suecarmol left a comment

Choose a reason for hiding this comment

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

Thanks for all of your work adding more documentation in key places in the library. I'll go ahead and merge this once I commit the suggestions below 😄

TWLight/users/groups.py Outdated Show resolved Hide resolved
TWLight/users/groups.py Outdated Show resolved Hide resolved
TWLight/users/helpers/authorizations.py Outdated Show resolved Hide resolved
@suecarmol suecarmol merged commit 9455b72 into WikipediaLibrary:master Jun 25, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants