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

Update examples.md #1163

Merged
merged 9 commits into from
Aug 17, 2023
Merged

Update examples.md #1163

merged 9 commits into from
Aug 17, 2023

Conversation

Why-not-now
Copy link
Contributor

@Why-not-now Why-not-now commented Jul 16, 2023

Summary

Changing order type annotations to fit code
Added attrs.define implementation to slots category

This is to fix the docs problems mentioned in #1162. There is still one line that I think is confusing, line 670:

You can still have power over the attributes if you pass a dictionary of name: {func}~attrs.field mappings and can pass arguments to @attrs.define:

Pull Request Check List

  • Added tests for changed code.
    Our CI fails if coverage is not 100%.
  • New features have been added to our Hypothesis testing strategy.
  • Changes or additions to public APIs are reflected in our type stubs (files ending in .pyi).
    • ...and used in the stub test file tests/typing_example.py.
    • If they've been added to attr/__init__.pyi, they've also been re-imported in attrs/__init__.pyi.
  • Updated documentation for changed code.
    • New functions/classes have to be added to docs/api.rst by hand.
    • Changes to the signature of @attr.s() have to be added by hand too.
    • Changed/added classes/methods/functions have appropriate versionadded, versionchanged, or deprecated directives.
      The next version is the second number in the current release + 1.
      The first number represents the current year.
      So if the current version on PyPI is 22.2.0, the next version is gonna be 22.3.0.
      If the next version is the first in the new year, it'll be 23.1.0.
  • Documentation in .rst files is written using semantic newlines.
  • Changes (and possible deprecations) have news fragments in changelog.d.
  • Consider granting push permissions to the PR branch, so maintainers can fix minor issues themselves without pestering you.

Changing order type annotations to fit code
Added attrs.define implementation to slots category
@Why-not-now Why-not-now marked this pull request as draft July 16, 2023 07:00
Copy link
Member

@hynek hynek left a comment

Choose a reason for hiding this comment

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

hi thanks and sorry for the delay!

if you apply my suggestions, I think this is good to go

tests/test_annotations.py Outdated Show resolved Hide resolved
tests/test_annotations.py Outdated Show resolved Hide resolved
docs/examples.md Outdated Show resolved Hide resolved
docs/examples.md Outdated Show resolved Hide resolved
hynek and others added 5 commits August 15, 2023 10:36
Co-authored-by: Hynek Schlawack <hs@ox.cx>
Co-authored-by: Hynek Schlawack <hs@ox.cx>
@Why-not-now Why-not-now marked this pull request as ready for review August 16, 2023 14:31
Copy link
Contributor Author

@Why-not-now Why-not-now left a comment

Choose a reason for hiding this comment

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

Finished review of suggested changes. Applied them.

@hynek hynek enabled auto-merge (squash) August 17, 2023 03:57
@hynek hynek merged commit 940dd1f into python-attrs:main Aug 17, 2023
20 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.

None yet

2 participants