Skip to content

DOC: Add .map to ExtensionArray reference#52247

Merged
mroeschke merged 5 commits into
pandas-dev:mainfrom
topper-123:add_ExtensionArray.map_docs
Mar 28, 2023
Merged

DOC: Add .map to ExtensionArray reference#52247
mroeschke merged 5 commits into
pandas-dev:mainfrom
topper-123:add_ExtensionArray.map_docs

Conversation

@topper-123

Copy link
Copy Markdown
Contributor

No description provided.

@mroeschke mroeschke added Docs ExtensionArray Extending pandas with custom dtypes or arrays. labels Mar 28, 2023
@mroeschke mroeschke added this to the 2.1 milestone Mar 28, 2023
@mroeschke mroeschke merged commit 2e0c8a4 into pandas-dev:main Mar 28, 2023
@mroeschke

Copy link
Copy Markdown
Member

Thanks @topper-123

@topper-123 topper-123 deleted the add_ExtensionArray.map_docs branch March 28, 2023 18:37
@rhshadrach

Copy link
Copy Markdown
Member

On the docs build here, I'm seeing

/home/runner/work/pandas/pandas/doc/source/reference/api/pandas.api.extensions.ExtensionArray.map.rst: WARNING: document isn't included in any toctree

I think this might be causing the docs build to "fail".

@mroeschke

Copy link
Copy Markdown
Member

Oops yeah jumped the gun on the merge. Will revert for now.

mroeschke added a commit that referenced this pull request Mar 28, 2023
@rhshadrach

Copy link
Copy Markdown
Member

@datapythonista - in this case the docs are still built successfully but I think we can't use /preview because the step is skipped. Is that right? I wonder if there is an easy way still be able to view the docs if something is built (but not a big issue either way).

mroeschke added a commit that referenced this pull request Mar 28, 2023
Revert "DOC: Add .map to ExtensionArray reference (#52247)"

This reverts commit 2e0c8a4.
@datapythonista

Copy link
Copy Markdown
Member

@datapythonista - in this case the docs are still built successfully but I think we can't use /preview because the step is skipped. Is that right? I wonder if there is an easy way still be able to view the docs if something is built (but not a big issue either way).

@rhshadrach we consider warnings as errors in the docs, for me the current behavior seems fine, even if I agree that the docs exist and we could preview them. The main problem I see is that it probably makes the CI quite complex to move forward with the publishing when the docs step is red. But I'm open to the change if things don't become too complicated.

@rhshadrach

Copy link
Copy Markdown
Member

Thanks @datapythonista - I suspect you're right, but will take a quick look into it to see if anything can be done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Docs ExtensionArray Extending pandas with custom dtypes or arrays.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants