{"action":"created","issue":{"url":"https://api.github.com/repos/pandas-dev/pandas/issues/20465","repository_url":"https://api.github.com/repos/pandas-dev/pandas","labels_url":"https://api.github.com/repos/pandas-dev/pandas/issues/20465/labels{/name}","comments_url":"https://api.github.com/repos/pandas-dev/pandas/issues/20465/comments","events_url":"https://api.github.com/repos/pandas-dev/pandas/issues/20465/events","html_url":"https://github.com/pandas-dev/pandas/pull/20465","id":307926983,"number":20465,"title":"DOC: update the pandas.DatetimeIndex docstring","user":{"login":"4bic","id":5486449,"avatar_url":"https://avatars0.githubusercontent.com/u/5486449?v=4","gravatar_id":"","url":"https://api.github.com/users/4bic","html_url":"https://github.com/4bic","followers_url":"https://api.github.com/users/4bic/followers","following_url":"https://api.github.com/users/4bic/following{/other_user}","gists_url":"https://api.github.com/users/4bic/gists{/gist_id}","starred_url":"https://api.github.com/users/4bic/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/4bic/subscriptions","organizations_url":"https://api.github.com/users/4bic/orgs","repos_url":"https://api.github.com/users/4bic/repos","events_url":"https://api.github.com/users/4bic/events{/privacy}","received_events_url":"https://api.github.com/users/4bic/received_events","type":"User","site_admin":false},"labels":[{"id":134699,"url":"https://api.github.com/repos/pandas-dev/pandas/labels/Docs","name":"Docs","color":"3465A4","default":false}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2018-03-23T07:27:59Z","updated_at":"2018-03-26T08:40:46Z","closed_at":null,"author_association":"CONTRIBUTOR","pull_request":{"url":"https://api.github.com/repos/pandas-dev/pandas/pulls/20465","html_url":"https://github.com/pandas-dev/pandas/pull/20465","diff_url":"https://github.com/pandas-dev/pandas/pull/20465.diff","patch_url":"https://github.com/pandas-dev/pandas/pull/20465.patch"},"body":"Checklist for the pandas documentation sprint (ignore this if you are doing\r\nan unrelated PR):\r\n\r\n- [x ] PR title is \"DOC: update the <your-function-or-method> docstring\"\r\n- [ ] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>`\r\n- [ ] The PEP8 style check passes: `git diff upstream/master -u -- \"*.py\" | flake8 --diff`\r\n- [x ] The html version looks good: `python doc/make.py --single <your-function-or-method>`\r\n- [ ] It has been proofread on language by another sprint participant\r\n\r\nPlease include the output of the validation script below between the \"```\" ticks:\r\n\r\n```\r\n################################################################################\r\n####################### Docstring (pandas.DatetimeIndex) #######################\r\n################################################################################\r\n\r\nStore timestamps using NumPy’s datetime64 dtype.\r\n\r\nImmutable ndarray of datetime64 data, represented internally as int64, and\r\nwhich can be boxed to Timestamp objects that are subclasses of datetime and\r\ncarry metadata such as frequency information.\r\n\r\nParameters\r\n----------\r\ndata  : array-like (1-dimensional), optional\r\n    Optional datetime-like data to construct index with\r\ncopy  : bool\r\n    Make a copy of input ndarray\r\nfreq : string or pandas offset object, optional\r\n    One of pandas date offset strings or corresponding objects\r\nstart : starting value, datetime-like, optional\r\n    If data is None, start is used as the start point in generating regular\r\n    timestamp data.\r\nperiods  : int, optional, > 0\r\n    Number of periods to generate, if generating index. Takes precedence\r\n    over end argument\r\nend   : end time, datetime-like, optional\r\n    If periods is none, generated index will extend to first conforming\r\n    time on or just past end argument\r\nclosed : string or None, default None\r\n    Make the interval closed with respect to the given frequency to\r\n    the 'left', 'right', or both sides (None)\r\ntz : pytz.timezone or dateutil.tz.tzfile\r\nambiguous : 'infer', bool-ndarray, 'NaT', default 'raise'\r\n    - 'infer' will attempt to infer fall dst-transition hours based on\r\n      order\r\n    - bool-ndarray where True signifies a DST time, False signifies a\r\n      non-DST time (note that this flag is only applicable for ambiguous\r\n      times)\r\n    - 'NaT' will return NaT where there are ambiguous times\r\n    - 'raise' will raise an AmbiguousTimeError if there are ambiguous times\r\ninfer_dst : boolean, default False\r\n    .. deprecated:: 0.15.0\r\n       Attempt to infer fall dst-transition hours based on order\r\nname : object\r\n    Name to be stored in the index\r\n\r\nAttributes\r\n----------\r\nyear\r\nmonth\r\nday\r\nhour\r\nminute\r\nsecond\r\nmicrosecond\r\nnanosecond\r\ndate\r\ntime\r\ndayofyear\r\nweekofyear\r\nweek\r\ndayofweek\r\nweekday\r\nquarter\r\ntz\r\nfreq\r\nfreqstr\r\nis_month_start\r\nis_month_end\r\nis_quarter_start\r\nis_quarter_end\r\nis_year_start\r\nis_year_end\r\nis_leap_year\r\ninferred_freq\r\n\r\nMethods\r\n-------\r\nnormalize\r\nstrftime\r\nsnap\r\ntz_convert\r\ntz_localize\r\nround\r\nfloor\r\nceil\r\nto_period\r\nto_perioddelta\r\nto_pydatetime\r\nto_series\r\nto_frame\r\nmonth_name\r\nday_name\r\n\r\nExamples\r\n--------\r\n>>> dates = pd.DatetimeIndex(freq='M', start='2018-3-10', periods=6)\r\n>>> dates\r\nDatetimeIndex(['2018-03-31', '2018-04-30', '2018-05-31',\r\n               '2018-06-30', '2018-07-31', '2018-08-31'],\r\n              dtype='datetime64[ns]', freq='M')\r\n\r\nNotes\r\n-----\r\nTo learn more about the frequency strings, please see `this link\r\n<http://pandas.pydata.org/pandas-docs/stable/timeseries.html#offset-aliases>`__.\r\n\r\nSee Also\r\n---------\r\nIndex : The base pandas Index type\r\nTimedeltaIndex : Index of timedelta64 data\r\nPeriodIndex : Index of Period data\r\n\r\n################################################################################\r\n################################## Validation ##################################\r\n################################################################################\r\n\r\nErrors found:\r\n\tErrors in parameters section\r\n\t\tParameters {'dtype', 'verify_integrity', 'data', 'copy', 'normalize', 'kwargs', 'periods', 'end'} not documented\r\n\t\tUnknown parameters {'copy ', 'end  ', 'infer_dst', 'periods ', 'data '}\r\n\r\n```\r\n\r\nIf the validation script still gives errors, but you think there is a good reason\r\nto deviate in this case (and there are certainly such cases), please state this\r\nexplicitly.\r\n\r\n\r\nChecklist for other PRs (remove this part if you are doing a PR for the pandas documentation sprint):\r\n\r\n- [ ] closes #xxxx\r\n- [ ] tests added / passed\r\n- [ ] passes `git diff upstream/master -u -- \"*.py\" | flake8 --diff`\r\n- [ ] whatsnew entry\r\n"},"comment":{"url":"https://api.github.com/repos/pandas-dev/pandas/issues/comments/376089571","html_url":"https://github.com/pandas-dev/pandas/pull/20465#issuecomment-376089571","issue_url":"https://api.github.com/repos/pandas-dev/pandas/issues/20465","id":376089571,"user":{"login":"pep8speaks","id":24736507,"avatar_url":"https://avatars1.githubusercontent.com/u/24736507?v=4","gravatar_id":"","url":"https://api.github.com/users/pep8speaks","html_url":"https://github.com/pep8speaks","followers_url":"https://api.github.com/users/pep8speaks/followers","following_url":"https://api.github.com/users/pep8speaks/following{/other_user}","gists_url":"https://api.github.com/users/pep8speaks/gists{/gist_id}","starred_url":"https://api.github.com/users/pep8speaks/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pep8speaks/subscriptions","organizations_url":"https://api.github.com/users/pep8speaks/orgs","repos_url":"https://api.github.com/users/pep8speaks/repos","events_url":"https://api.github.com/users/pep8speaks/events{/privacy}","received_events_url":"https://api.github.com/users/pep8speaks/received_events","type":"User","site_admin":false},"created_at":"2018-03-26T08:40:45Z","updated_at":"2018-03-26T08:40:45Z","author_association":"NONE","body":"Hello @4bic! Thanks for updating the PR.\n\n - In the file [`pandas/core/indexes/datetimes.py`](https://github.com/pandas-dev/pandas/blob/11e34a088b099c62c8a9b01768c84aecd4ed6fcf/pandas/core/indexes/datetimes.py), following are the PEP8 issues :\n\n> [Line 279:80](https://github.com/pandas-dev/pandas/blob/11e34a088b099c62c8a9b01768c84aecd4ed6fcf/pandas/core/indexes/datetimes.py#L279): [E501](https://duckduckgo.com/?q=pep8%20E501) line too long (81 > 79 characters)\n\n"}}
{"actor":{"display_login":"pep8speaks"}}