Skip to content

Add regendoc runs for fixture docs #8312

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

Conversation

matthewhughes934
Copy link
Contributor

@matthewhughes934 matthewhughes934 commented Feb 3, 2021

  • Fix various typos in fixture docs

  • Add basic emaillib for tests in fixture.rst

    This will be used to power regendoc runs for later tests

  • Add regendoc runs for emaillib tests in fixture

    Also update these tests ensure they pass.

    This addresses Use regendoc in fixture.rst #8213


I've run regendoc locally to ensure the added tests pass, but the resulting diff was rather large (and included some bad whitespace) so I've left it out. What might be best here? I was thinking of just commiting the results of the added tests.

Copy link
Member

@bluetech bluetech left a comment

Choose a reason for hiding this comment

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

The changes look good to me!

Copy link
Member

@nicoddemus nicoddemus left a comment

Choose a reason for hiding this comment

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

LGTM, thanks a lot @matthewhughes934!

I've run regendoc locally to ensure the added tests pass, but the resulting diff was rather large (and included some bad whitespace) so I've left it out. What might be best here? I was thinking of just commiting the results of the added tests.

I'm surprise there were many changes... did you run on Linux using Python 3.8?

@matthewhughes934
Copy link
Contributor Author

I'm surprise there were many changes... did you run on Linux using Python 3.8?

Ah, I was running on 3.9. Diff is reasonable after a run on 3.8: 10dd3db

@nicoddemus
Copy link
Member

Awesome, thanks a lot!

Normally we squash the commits before merging, but I noticed you have some commits with !fixup... would you like to rebase the history yourself before we merge, or can I go ahead and hit Squash here on GitHub?

Also update these tests ensure they pass, and be explicit about the test
file called in an existing test to avoid unintentional calls to the
added tests
This is the result of running:

    $ cd doc/en && make regen REGENDOC_FILES=fixture.rst
@matthewhughes934 matthewhughes934 force-pushed the add-regendoc-runs-for-fixture-docs branch from 10dd3db to 709c211 Compare February 4, 2021 18:33
@matthewhughes934
Copy link
Contributor Author

Awesome, thanks a lot!

Normally we squash the commits before merging, but I noticed you have some commits with !fixup... would you like to rebase the history yourself before we merge, or can I go ahead and hit Squash here on GitHub?

👍 rebased

@nicoddemus nicoddemus enabled auto-merge February 4, 2021 18:34
@nicoddemus nicoddemus merged commit bebb695 into pytest-dev:master Feb 4, 2021
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