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

SAS and XSPEC command docstrings don't get parsed into Sphinx documentation #313

Closed
DavidT3 opened this issue Jan 5, 2021 · 1 comment
Closed
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@DavidT3
Copy link
Owner

DavidT3 commented Jan 5, 2021

This seems likely to be because of the decorator function I use to allow the commands to be run through actual SAS or XSPEC in terminal. I'll have to go looking for a solution to this, because the SAS and XSPEC functions are key to the whole module, it wouldn't be good if they were undocumented.

@DavidT3 DavidT3 added bug Something isn't working documentation Improvements or additions to documentation labels Jan 5, 2021
@DavidT3 DavidT3 self-assigned this Jan 5, 2021
@DavidT3
Copy link
Owner Author

DavidT3 commented Jan 5, 2021

This is a known behaviour of autodoc (sphinx-doc/sphinx#7650), as the decorator conceals the true signature of the decorated function from autodoc.

One way around this apparently is to use the functools.wraps decorator

@DavidT3 DavidT3 mentioned this issue Jan 5, 2021
@DavidT3 DavidT3 closed this as completed Jan 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant