Skip to content

change the order of cache and byeaster in rrule docstring#695

Merged
pganssle merged 2 commits into
dateutil:masterfrom
ridhi1412:rmahajan_rrule_docs
Apr 22, 2018
Merged

change the order of cache and byeaster in rrule docstring#695
pganssle merged 2 commits into
dateutil:masterfrom
ridhi1412:rmahajan_rrule_docs

Conversation

@ridhi1412

@ridhi1412 ridhi1412 commented Apr 20, 2018

Copy link
Copy Markdown
Contributor

Changed order in the rrule docstring to match with order of the keywords.
Closes #686

@pganssle

pganssle commented Apr 20, 2018

Copy link
Copy Markdown
Member

@rmahajan14 You need to add yourself to the AUTHORS.md file and add a changelog.d/695.doc.rst file please. See CONTRIBUTING.md

@pganssle pganssle added this to the Master milestone Apr 20, 2018
Comment thread AUTHORS.md Outdated
@@ -1,4 +1,4 @@
This is a (possibly incomplete) list of all the contributors to python-dateutil,
This is a (possibly incomplete) list of all the contributors to python-dateutil,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are a bunch of weird unprintable characters at the beginning of this line. Is this something your editor is doing?

with open('AUTHORS.md', 'rb') as f:
    print(f.read(60))
# Result:
# b'\xef\xbb\xbfThis is a (possibly incomplete) list of all the contribut'

Since the sequence is 0xEFBBBF, I'm guessing that it's a Windows Byte Order Mark indicating UTF-8. I recommend that you fix your editor so that it doesn't do this anymore.

@pganssle
pganssle force-pushed the rmahajan_rrule_docs branch from 0350492 to 2385720 Compare April 22, 2018 00:14
The documentation had cache and byeaster out of order from their
appearance in the function's parameter list.

- Added changelog for documentation change
@pganssle
pganssle force-pushed the rmahajan_rrule_docs branch from 2385720 to 8b91ed0 Compare April 22, 2018 00:20
@pganssle
pganssle merged commit ed7d5ad into dateutil:master Apr 22, 2018
@pganssle pganssle mentioned this pull request May 9, 2018
@pganssle pganssle added the rrule label Jul 12, 2019
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.

Ordering in the rrule documentation keywords explanation

2 participants