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

Documented classes in io.ascii.core #2142

Merged
merged 2 commits into from
Feb 27, 2014

Conversation

mdmueller
Copy link
Contributor

As addressed in issue #2141.

@astrofrog
Copy link
Member

@amras1 - thanks! Note that the numpydoc convention for docstrings is:

"""
Single sentence here.

More description here if needed. Can have multiple sentences.
"""

Only the first line will appear in the summary table of classes/functions/methods. Could you update this pull request to reflect this?

@mdmueller
Copy link
Contributor Author

Sure thing!

@taldcroft
Copy link
Member

@amras1 - looks great, merging!

taldcroft added a commit that referenced this pull request Feb 27, 2014
Documented classes in io.ascii.core
@taldcroft taldcroft merged commit 10b3489 into astropy:master Feb 27, 2014
@taldcroft
Copy link
Member

@astrofrog - this removes the "intruders" mentioned in #2141 but probably not all the undocumented objects that will raise Sphinx warnings. Should we close #2141 now?

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

Successfully merging this pull request may close these issues.

None yet

3 participants