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 tests for dataclasses: autodoc and autosummary #9236

Closed
wants to merge 4 commits into from
Closed

Add tests for dataclasses: autodoc and autosummary #9236

wants to merge 4 commits into from

Conversation

pbudzyns
Copy link
Contributor

@pbudzyns pbudzyns commented May 16, 2021

Subject: Add tests with dataclasses

This PR is a continuation to #9146 where support for instance attributes in autosummary was added. As Phil correctly pointed out this change also fixes generated content for dataclasses. This change was hard to notice because there were no unit tests including dataclasses present. As dataclasses became somehow standard thing for python >= 3.7 I believe it's a good idea to test if content generated for them is correct.

Feature or Bugfix

  • Testing

Purpose

  • Test documenting dataclasses

Relates

@tk0miya
Copy link
Member

tk0miya commented May 22, 2021

I feel no additional tests are needed for dataclasses. The mechanism is the same as the instance attributes annotations.

Note: I think the testcases for namedtuple is also not needed by the same reason.

@tk0miya tk0miya closed this Jul 6, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 6, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants