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

Improve py4py documentation #809

Closed
smangham opened this issue Jan 26, 2021 · 4 comments · Fixed by #1106
Closed

Improve py4py documentation #809

smangham opened this issue Jan 26, 2021 · 4 comments · Fixed by #1106
Assignees

Comments

@smangham
Copy link
Collaborator

smangham commented Jan 26, 2021

A few small issues with the py4py reverb docs:

  • The continuum argument for TF creation doesn't specify it should be central source + disk luminosity.
  • The keplerian argument for TF.plot doesn't explain it should be in r_ISCO.
@smangham smangham self-assigned this Jan 26, 2021
@smangham
Copy link
Collaborator Author

The threshold argument for TransferFunction.delay doesn't mention it's fractional. It should also mention .8 was the 'standard', ideally referencing the paper I got that from (which I can't remember right now!).

@smangham
Copy link
Collaborator Author

TransferFunction.plot is designed to chain and returns the TransferFunction on completion. It should have an option to return the actual figure created, in case users want to modify it further.

@smangham
Copy link
Collaborator Author

I forgot I still had a large script called "py4py,.py" in there that I was in the process of breaking up into smaller ones. I'll check this. Also, at some point (???) I decided to setup smangham/py4py separately from this repo. Presumably I was going to maintain it as its own thing then gave up and folded it in. I'll delete that repo.

@smangham
Copy link
Collaborator Author

This is ready, but being held up by Sphinx dependency hell. For some reason we had docutils pinned to <0.18? Anyway, builds now, looks fine.

jhmatthews added a commit that referenced this issue May 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants