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

docs: Update mypy documentation on django-stubs #23148

Merged
merged 3 commits into from
Oct 6, 2022
Merged

Conversation

PIG208
Copy link
Member

@PIG208 PIG208 commented Oct 6, 2022

This is a follow-up to #18777.

Some additional documentation is added regarding features supported by django-stubs.

Screenshots and screen captures:

Self-review checklist

  • Self-reviewed the changes for clarity and maintainability
    (variable names, code reuse, readability, etc.).

Communicate decisions, questions, and potential concerns.

  • Explains differences from previous plans (e.g., issue description).
  • Highlights technical choices and bugs encountered.
  • Calls out remaining decisions and concerns.
  • Automated tests verify logic where appropriate.

Individual commits are ready for review (see commit discipline).

  • Each commit is a coherent idea.
  • Commit message(s) explain reasoning and motivation for changes.

Completed manual review and testing of the following:

  • Visual appearance of the changes.
  • Responsiveness and internationalization.
  • Strings and tooltips.
  • End-to-end functionality of buttons, interactions and flows.
  • Corner cases, error conditions, and easily imagined bugs.

@PIG208 PIG208 force-pushed the mypydoc branch 4 times, most recently from 2846b5e to e66b0c4 Compare October 6, 2022 04:52
docs/testing/mypy.md Outdated Show resolved Hide resolved
docs/testing/mypy.md Outdated Show resolved Hide resolved
docs/testing/mypy.md Outdated Show resolved Hide resolved
docs/testing/mypy.md Outdated Show resolved Hide resolved
docs/testing/mypy.md Outdated Show resolved Hide resolved
Signed-off-by: Zixuan James Li <p359101898@gmail.com>
Signed-off-by: Zixuan James Li <p359101898@gmail.com>
This adds examples for QuerySet, ValuesQuerySet, TestHttpResponse, which
are some common examples that need a bit of extra care when typing.

Signed-off-by: Zixuan James Li <p359101898@gmail.com>
@timabbott
Copy link
Sponsor Member

I did a bit of copyediting, mainly to describe what a QuerySet is with an example before we talk about those in detail, and then merged this. Thanks @PIG208! I'd appreciate your advertising these documentation updates and asking for feedback; it's possible even with my edits we don't provide enough context.

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

Successfully merging this pull request may close these issues.

None yet

4 participants