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

Python docs improvements #52

Closed
1 task
bluescarni opened this issue Mar 25, 2017 · 1 comment
Closed
1 task

Python docs improvements #52

bluescarni opened this issue Mar 25, 2017 · 1 comment

Comments

@bluescarni
Copy link
Member

Keep track of useful improvements to the Python documentation:

  • document special members such as __len__, __getitem__, __copy__, __deepcopy__ that are implemented in some classes (e.g., island, archipelago, population, etc.). This can be done by adding the sphinx directive :special-members: to the autoclass directive, but then this brings in the __init__ documentation which is repeated in the class description. Need to find a way to make it all look consistent and nice.
@bluescarni bluescarni modified the milestone: PaGMO 2.0 Mar 25, 2017
@bluescarni
Copy link
Member Author

bluescarni commented Mar 25, 2017

moved to #53

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant