Skip to content

Conversation

@pganssle
Copy link
Member

Fix inaccurate documentation - fixes #80.

Also I've adjusted the formatting of the docs. There's still some significant repetition of text here, it would be best to figure out the right way to transclude that information so it can be more easily updated, but I'll leave that for a later fix.

@jarondl
Copy link
Member

jarondl commented Aug 3, 2015

LGTM.
In the future, now that readthedocs.com supports napoleon,
do you think we should migrate to numpydoc style?

@pganssle
Copy link
Member Author

@jarondl I'm not familiar enough with the numpydoc style to understand the advantages, but I'm not married to any particular documentation style. The biggest issue for me is when you have large numbers of "inherited" kwargs that you want to document (e.g. parse() passing on its *kwargs* to the parser() constructor) - it'd be nice to be able to just include an inline reference to the "inherited" kwargs from the base class/function.

pganssle added a commit that referenced this pull request Aug 21, 2015
@pganssle pganssle merged commit a60e456 into master Aug 21, 2015
@pganssle pganssle deleted the tzinfo-docfix branch September 8, 2015 22:38
aschatten pushed a commit to aschatten/dateutil that referenced this pull request Nov 16, 2015
@pganssle pganssle added this to the 2.5.0 milestone Feb 25, 2016
@pganssle pganssle mentioned this pull request Feb 26, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

parser.parse does not apply time zone to date if ignoretz is True and tzinfos is given

3 participants