Docs readthrough [WIP] #962
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
halotools/mock_observables/pairwise_velocities/engines/velocity_marking_functions.pyx
Show resolved
Hide resolved
halotools/mock_observables/two_point_clustering/angular_tpcf.py
Outdated
Show resolved
Hide resolved
halotools/mock_observables/large_scale_density/large_scale_density_spherical_annulus.py
Show resolved
Hide resolved
aphearin
force-pushed
the
docs-readthrough
branch
from
07e22b7 to
65bcb33
Compare
|
I rebased on ce9bf4e, which passes on Travis. Everything passes with this PR except for the docs build, so there must have been a breaking change to the docs somewhere. Now trying to track it down. |
aphearin
approved these changes
Jan 7, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is ready to be looked at.
I've tried to explain why I've done things when it isn't obvious. This is either done with github comments, or comments in the code prefixed with
cbx_orcbx_aph. There are also a couple of open question in the code. Please ping me if anything is unclear.About 50% of the changes are straight docs changes. The rest are mostly function with unused arguments. In those cases I've remove the args (and made the related docs change!). There are a couple of places where things are a bit more complicated - i.e. the docs claim that something is optional when it is not, or I've noticed something wrong.
I've tried to only make these more complicated changes when 1) they are a bug, and 2) they are very small/easy to fix.
I'm sorry if any of these changes are pedantry :)
A crazy idea that I had: There are a ton of duplicated docs (such as the one for
approx_cell1_sizein all the pairfinders. You could define the somewhere and then include them in the docs with a format string. I was briefly excited by this but now think it is a bad idea - too much complexity for minimal gain.I'm reasonably confident that test failures aren't related to what I've done.
Please feel free to keep/throw away parts of these changes. It's also a pretty spotty lookover - I mainly looked at the parts of HT that I use the most. The codebase is much larger that I thought before I tried to look at all of it :)