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

makers.utils undocumented online #3679

Closed
Tobychev opened this issue Dec 6, 2021 · 3 comments · Fixed by #3753 or #3760
Closed

makers.utils undocumented online #3679

Tobychev opened this issue Dec 6, 2021 · 3 comments · Fixed by #3753 or #3760
Assignees
Labels
Milestone

Comments

@Tobychev
Copy link

Tobychev commented Dec 6, 2021

Gammapy version
0.18.2

Bug description
make_theta_squared_table docstring does not show up in the documentation search, and I can't find it via the menu either. Probably applies for all functions in that subpackage, but I haven't checked.

The function has a proper docstring, it's just not been caught during generation of the html page, and is thus hard to discover.

To Reproduce
Go to docs.gammapy.org and search for make_theta_squared_table, the only hit is in an example.

@Tobychev Tobychev added the bug label Dec 6, 2021
@github-actions
Copy link

github-actions bot commented Dec 6, 2021

Merci! We will respond to your issue shortly. In the meantime, try import gammapy; gammapy.song()

@adonath adonath added this to the 1.0 milestone Dec 6, 2021
@adonath adonath added this to To Do in DOCUMENTATION via automation Dec 6, 2021
@adonath adonath changed the title makers.util undocumented online makers.utils undocumented online Dec 9, 2021
@registerrier registerrier added docs and removed bug labels Jan 21, 2022
@registerrier
Copy link
Contributor

Note that it appears in hess tutorials.

@bkhelifi
Copy link
Member

I will add it in the PR about the missing links into the documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
No open projects
DOCUMENTATION
  
Done
Status: Done
5 participants