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

Refactor the reference section of the docs #4311

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

tybug
Copy link
Member

@tybug tybug commented Mar 18, 2025

Still a large pr but there's no sane way to split most of this without causing more work for me, thanks to all the inter-references. I could split the redirect extension off is probably the biggest thing

There's a minor amount of added or removed content here, but most of it is moving around existing stuff into their own page

Comment on lines +3 to +5
======
Django
======
Copy link
Member Author

Choose a reason for hiding this comment

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

I could be talked into keeping "Hypothesis for Django". I lean pretty minimalist in general (in life, designs, wording, etc), but I realize I can go too far sometimes.

@@ -1,19 +1,8 @@
====================
Reproducing failures
====================
Copy link
Member Author

Choose a reason for hiding this comment

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

My heading ordering is single =, single -, single ~ (and if you need to go beyond that you're probably doomed anyway). I try to avoid double headers for anything, but I think I might be the odd one out here, because e.g. the python rst guide recommends double headers for chapters. In defense of single headers, the python docs have way more structure than we do!

Comment on lines +88 to +97
Misc
----

.. autofunction:: hypothesis.strategies.builds
.. autofunction:: hypothesis.strategies.functions
.. autofunction:: hypothesis.strategies.slices

.. autofunction:: hypothesis.strategies.sampled_from
.. autofunction:: hypothesis.strategies.permutations

Copy link
Member Author

Choose a reason for hiding this comment

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

categorization is hard...would be happy to hear advice on how to categorize the strategies (either these misc ones, or any of the other ones too)

@tybug tybug mentioned this pull request Mar 18, 2025
12 tasks
ab_c = (a + b) + c
a_bc = a + (b + c)
difference = abs(ab_c - a_bc)
target(difference) # Without this, the test almost always passes
Copy link
Contributor

Choose a reason for hiding this comment

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

As fas as I can tell, target makes little difference here. Around 40% discover rate with or without it.

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.

2 participants