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 documentation on writing tests for Breathe #931

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

emilydolson
Copy link

Thanks for all of your work developing Breathe! I just worked my way through the process of figuring out how to write tests for Breathe. While it's still fresh in my head, I jotted down everything I wish I had known from the beginning in case it is helpful to others. This PR adds that additional information to the documentation.

Obviously, I'm happy to change anything that needs changing - you all have way more experience writing tests for Breathe than I do! I figured this could be a helpful starting point, though.

Also, I noticed that test_renderer.py is missing a WrappedSectionDef class, as well as a renderer capable of rendering sectiondefs (since the rendering process ends up trying to access the renderer's state member and throws an error when it is None). I tweaked the existing renderer to be able to handle a sectiondef, but then didn't end up needing it for my tests. That said, I could totally imagine others needing that functionality for writing tests. Would it be helpful for me to add these features to this PR? Or would you rather not add anything to the testing suite that isn't currently being used?

Choose a reason for hiding this comment

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

This flow chart looks great. Small typo in Breath.

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