Skip to content

Conversation

bdewilde
Copy link
Collaborator

@bdewilde bdewilde commented Dec 4, 2021

Description

  • adds session-scoped fixtures to tests and uses them where possible throughout unit test suite
  • adds an actual quickstart to the docs, and moves the old quickstart to a slightly updated "walkthrough"
  • improves some documentation in the code

Motivation and Context

This improves maintainability (and performance?) of the testing suite, which means less hassle for me. It also fixes some issues with the walkthrough (out-of-date code and now-irrelevant notes), and adds a proper quickstart, so new users have a better introduction to the package's functionality.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation, and I have updated it accordingly.

@bdewilde bdewilde marked this pull request as ready for review December 5, 2021 18:38
@bdewilde bdewilde merged commit 6f39292 into develop Dec 5, 2021
@bdewilde bdewilde deleted the update-tests-and-docs branch December 5, 2021 18:45
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.

1 participant