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 unit test documentation #3220

Merged
merged 1 commit into from
Jul 24, 2024
Merged

docs: update unit test documentation #3220

merged 1 commit into from
Jul 24, 2024

Conversation

lucasmoura
Copy link
Contributor

Why is this needed?

We are now telling the user to run make deps before calling tox and also removing any mention to pyenv, as we don't use that anymore for our tests.

  • (un)check this to re-run the checklist action

@github-actions github-actions bot added the docs label Jul 24, 2024
@orndorffgrant
Copy link
Collaborator

This looks good, just needs a rebase and conflict resolution

@lucasmoura
Copy link
Contributor Author

@orndorffgrant done

Copy link
Contributor

@s-makin s-makin left a comment

Choose a reason for hiding this comment

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

One tiny nit (not a blocker)


First, run the script to install and configure `pyenv`, and the `tox` dependencies:
All unit and lint tests are run using `tox`. However, before we can run our tests, we need to
install some package dependencies. This can be achieve through our Makefile script. To install those
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
install some package dependencies. This can be achieve through our Makefile script. To install those
install some package dependencies. This can be achieved through our Makefile script. To install those

We are now telling the user to run make deps before calling tox
and also removing any mention to pyenv, as we don't use that
anymore for our tests.

Fixes: #2892
@lucasmoura
Copy link
Contributor Author

@s-makin fixed

@s-makin s-makin merged commit 93bc662 into docs Jul 24, 2024
7 checks passed
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.

3 participants