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

Complete Python docstrings for wrapped SBProfile / C++ code #53

Closed
barnabytprowe opened this issue Mar 26, 2012 · 2 comments
Closed

Complete Python docstrings for wrapped SBProfile / C++ code #53

barnabytprowe opened this issue Mar 26, 2012 · 2 comments
Assignees
Labels
docs Related to documentation
Milestone

Comments

@barnabytprowe
Copy link
Member

It seemed to me that the Python docstrings for the wrapped SBProfile objects could be added to, and given my recent documentation of the SBProfile class in C++ it seems I'd be a good person to take this on. This shouldn't break code, so I won't create a separate branch. I might ping @TallJimbo from time to time with a question / issue!

@ghost ghost assigned barnabytprowe Mar 26, 2012
@rmjarvis
Copy link
Member

I think we can close this issue. The relevant docstrings are all for our GSObject classes. Barney recently did a bunch of work making sure all the important wrapped classes have docstrings in python, and I don't think we need to do the same for the SB classes. Those should be considered implementation details for how the GSObjects work. So C++-only documentation probably makes sense.

@rmandelb
Copy link
Member

I agree. This is 6 months old, so to put it in context, I'm not even sure we had an implementation for the base classes as containers for wrapped SBProfiles yet. Our C++ documentation for SBProfiles is good, our docstrings for the base classes is good. That's enough.

@rmjarvis rmjarvis removed the core label Nov 21, 2016
@rmjarvis rmjarvis added this to the Will not fix milestone Feb 16, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Related to documentation
Projects
None yet
Development

No branches or pull requests

3 participants