change API documentation from time.core to just time #1028
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a pretty trivial PR that probably only @taldcroft will care about.
This changes the documentation for the
time
subpackage to be an API forastropy.time
instead ofastropy.time.core
. Right now, this doesn't change what classes/functions are documented becauseastropy/time/__init__.py
just hasfrom .core import *
in it.I think it's better to do it this way, though, because now if I put
astropy.time
in the docs (or someone else does via intersphinx) it will link to that page, instead of having no link (because it thinks it's documentiongastropy.time.core
). It's also marginally clearer this way to users that they should dofrom astropy.time import foo
instead offrom astropy.time.core import foo
.Or is there some other reason you had for using
core
over the base package, @taldcroft?