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

How to include documentation in the automatically generated python wrapper? #10

Open
jwoillez opened this issue Nov 6, 2014 · 1 comment

Comments

@jwoillez
Copy link
Contributor

jwoillez commented Nov 6, 2014

At the moment, the ERFA documentation is in the *.c files, and therefore not available in a packaged version, the way most users will get it. I can see two options:

Option 1: Pull the sources with git and get the documentation from the *.c files, when generating the wrapper.

Option 2: Copy the documentation from the *.c to erfa.h when using erfa-fetch, and get it from erfa.h.

Opinions?

@jwoillez
Copy link
Contributor Author

jwoillez commented Nov 6, 2014

Note: Option 2 is liberfa/erfa#24

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

No branches or pull requests

1 participant