Skip to content

DOC: document is_* type methods #15895

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.

Sign up for GitHub

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

Jump to bottom
Closed
jreback opened this issue Apr 4, 2017 · 2 comments
Closed

DOC: document is_* type methods #15895

jreback opened this issue Apr 4, 2017 · 2 comments
Labels
Docs

Comments

@jreback
Copy link
Contributor

jreback commented Apr 4, 2017 •
edited
Loading

Most of the methods in here are exposed publicly thru pandas.api.types.

We would like to write full doc-strings for these (and examples!).

Multiple people could work on this.
@jreback jreback added this to the Next Major Release milestone Apr 4, 2017
@jreback jreback mentioned this issue Apr 4, 2017
Closed
gfyoung added a commit to forking-repos/pandas that referenced this issue Apr 5, 2017
@gfyoung
DOC: Document all of inference.py
3c477be 
Partially addresses pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue Apr 5, 2017
@gfyoung
DOC: Document all of inference.py
ba08e6d 
Partially addresses pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue Apr 5, 2017
@gfyoung
DOC: Document all of inference.py
5a8f8da 
Partially addresses pandas-devgh-15895.
jreback pushed a commit that referenced this issue Apr 5, 2017
@gfyoung @jreback
ENH: Add file buffer validation to I/O ops
e4e87ec 
1) Allows for more uniform handling of invalid file buffers to our `read_*` functions.
2) Adds a ton of new documentation to `inference.py`

Closes #15337.
xref #15895.

Author: gfyoung <[email protected]>

Closes #15894 from gfyoung/validate-file-like and squashes the following commits:

5a8f8da [gfyoung] DOC: Document all of inference.py
81103f7 [gfyoung] ENH: Add file buffer validation to I/O ops
gfyoung added a commit to forking-repos/pandas that referenced this issue Apr 7, 2017
@gfyoung
DOC: document pandas.types.common
475f870 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue Apr 7, 2017
@gfyoung
DOC: document pandas.types.common
29b4b58 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue Apr 7, 2017
@gfyoung
DOC: document pandas.types.common
077c6df 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue Apr 7, 2017
@gfyoung
DOC: document pandas.types.common
d624031 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue Apr 7, 2017
@gfyoung
DOC: document pandas.types.common
ba32185 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue Apr 7, 2017
@gfyoung
DOC: document pandas.types.common
e9e2a7f 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue Apr 7, 2017
@gfyoung
DOC: document pandas.types.common
7fb63fb 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue Apr 7, 2017
@gfyoung
DOC: document pandas.types.common
a5e8b23 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue Apr 7, 2017
@gfyoung
DOC: document pandas.types.common
568812d 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue Apr 7, 2017
@gfyoung
DOC: document pandas.types.common
7ccd84c 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue Apr 7, 2017
@gfyoung
DOC: document pandas.types.common
7275268 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue Apr 7, 2017
@gfyoung
DOC: document pandas.types.common
8e8b236 
Partially addresses pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue Apr 7, 2017
@gfyoung
DOC: document internal methods in types/common.py
f19a426 
Partially addresses pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue Apr 7, 2017
@gfyoung
DOC: document internal methods in types/common.py
af02bde 
Partially addresses pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue Apr 7, 2017
@gfyoung
DOC: document internal methods in types/common.py
2b19fc8 
Partially addresses pandas-devgh-15895.
@gfyoung gfyoung mentioned this issue Apr 7, 2017
Merged
gfyoung added a commit to forking-repos/pandas that referenced this issue Apr 7, 2017
@gfyoung
DOC: document internal methods in types/common.py
327d561 
Partially addresses pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue Apr 7, 2017
@gfyoung
DOC: document internal methods in types/common.py
a3cc121 
Partially addresses pandas-devgh-15895.
jreback pushed a commit that referenced this issue Apr 7, 2017
@gfyoung @jreback
BUG/DOC: Add documentation in types/common.py (#15941)
bc2fa16 
* DOC: document internal methods in types/common.py

Partially addresses gh-15895.

* BUG: Catch TypeError when calling _get_dtype

The following functions were not catching
the TypeError raised by _get_dtype:

1) is_string_dtype
2) is_string_like_dtype
3) is_timedelta64_ns_dtype

Thus, when "None" was passed in, an
Exception was raised instead of returning
False, as other functions did.

* TST: use ids to have nice parameterized function names
@gfyoung
Copy link
Member

gfyoung commented May 2, 2017 •
edited
Loading

@jreback : Could you update the URL in the issue to point to pandas.core.dtypes.common now?

gfyoung added a commit to forking-repos/pandas that referenced this issue May 2, 2017
@gfyoung
DOC: Document pandas.core.dtypes.common
a40ce3b 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue May 2, 2017
@gfyoung
DOC: Document pandas.core.dtypes.common
d523559 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue May 2, 2017
@gfyoung
DOC: Document pandas.core.dtypes.common
889e2a7 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue May 2, 2017
@gfyoung
DOC: Document pandas.core.dtypes.common
29604b0 
Closes pandas-devgh-15895.
@jreback
Copy link
Contributor Author

jreback commented May 3, 2017

done

gfyoung added a commit to forking-repos/pandas that referenced this issue May 3, 2017
@gfyoung
DOC: Document pandas.core.dtypes.common
3e4d47c 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue May 3, 2017
@gfyoung
DOC: Document pandas.core.dtypes.common
95f2616 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue May 3, 2017
@gfyoung
DOC: Document pandas.core.dtypes.common
17d1c96 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue May 3, 2017
@gfyoung
DOC: Document pandas.core.dtypes.common
f5954bd 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue May 3, 2017
@gfyoung
DOC: Document pandas.core.dtypes.common
1e486ae 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue May 3, 2017
@gfyoung
DOC: Document pandas.core.dtypes.common
96bb074 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue May 3, 2017
@gfyoung
DOC: Document pandas.core.dtypes.common
5687b59 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue May 3, 2017
@gfyoung
DOC: Document pandas.core.dtypes.common
8b7c0df 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue May 3, 2017
@gfyoung
DOC: Document pandas.core.dtypes.common
c315959 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue May 4, 2017
@gfyoung
DOC: Document pandas.core.dtypes.common
39620a4 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue May 4, 2017
@gfyoung
DOC: Document pandas.core.dtypes.common
0d0bc4f 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue May 4, 2017
@gfyoung
DOC: Document pandas.core.dtypes.common
78d595e 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue May 4, 2017
@gfyoung
DOC: Document pandas.core.dtypes.common
663590d 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue May 4, 2017
@gfyoung
DOC: Document pandas.core.dtypes.common
0e05980 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue May 4, 2017
@gfyoung
DOC: Document pandas.core.dtypes.common
9b80ac5 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue May 4, 2017
@gfyoung
DOC: Document pandas.core.dtypes.common
f7d4e4b 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue May 4, 2017
@gfyoung
DOC: Document pandas.core.dtypes.common
73cd6a9 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue May 4, 2017
@gfyoung
DOC: Document pandas.core.dtypes.common
21c3b2a 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue May 4, 2017
@gfyoung
DOC: Document pandas.core.dtypes.common
0a852d3 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue May 4, 2017
@gfyoung
DOC: Document pandas.core.dtypes.common
b0bf7c6 
Closes pandas-devgh-15895.
gfyoung added a commit to forking-repos/pandas that referenced this issue May 4, 2017
@gfyoung
DOC: Document pandas.core.dtypes.common
d9acf46 
Closes pandas-devgh-15895.
@gfyoung gfyoung mentioned this issue May 4, 2017
Merged
jreback pushed a commit that referenced this issue May 4, 2017
@gfyoung @jreback
DOC, TST: Document and Test Functions in dtypes/common.py (#16237)
1a0c878 
* DOC: Document pandas.core.dtypes.common

Closes gh-15895.

* TST: Add tests for pandas.core.dtypes.common

The testing of this module was especially lacking
with the exception of is_dtype_equal and pandas_dtype.
pcluo pushed a commit to pcluo/pandas that referenced this issue May 22, 2017
@gfyoung @pcluo
DOC, TST: Document and Test Functions in dtypes/common.py (pandas-dev…
bdb6b09 
…#16237)

* DOC: Document pandas.core.dtypes.common

Closes pandas-devgh-15895.

* TST: Add tests for pandas.core.dtypes.common

The testing of this module was especially lacking
with the exception of is_dtype_equal and pandas_dtype.
stangirala pushed a commit to stangirala/pandas that referenced this issue Jun 11, 2017
@gfyoung @stangirala
DOC, TST: Document and Test Functions in dtypes/common.py (pandas-dev…
83c1b43 
…#16237)

* DOC: Document pandas.core.dtypes.common

Closes pandas-devgh-15895.

* TST: Add tests for pandas.core.dtypes.common

The testing of this module was especially lacking
with the exception of is_dtype_equal and pandas_dtype.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jreback @gfyoung