Skip to content

Conversation

@steff456
Copy link
Member

@steff456 steff456 commented Dec 22, 2021

This PR converts the creation functions markdown into rst

Ref: #283

@steff456 steff456 added the Maintenance Bug fix, typo fix, or general maintenance. label Dec 22, 2021
@steff456 steff456 added this to the v2022 milestone Dec 22, 2021
@steff456 steff456 requested review from kgryte and rgommers December 22, 2021 00:05
@steff456 steff456 self-assigned this Dec 22, 2021
@rgommers rgommers modified the milestones: v2022, v2021 Jan 3, 2022
@asmeurer
Copy link
Member

asmeurer commented Jan 3, 2022

(I'm looking at all the md -> rst PRs)

The overall formatting here looks fine. One unfortunate thing is that autosummary uses these brackets in the table instead of the actual Python signature:
Screen Shot 2022-01-03 at 2 13 25 PM

There isn't an option to disable this, but I found it can be disabled with a simple workaround in conf.py

import sphinx.ext.autosummary as autosummary_mod
if hasattr(autosummary_mod, '_module'):
    # It's a sphinx deprecated module wrapper object
    autosummary_mod = autosummary_mod._module
autosummary_mod.mangle_signature = lambda sig, max_chars=30: sig

See sphinx-doc/sphinx#10053.

If you agree, I can make PR with this.

@steff456
Copy link
Member Author

If you agree, I can make PR with this.

I think it is a good idea, please make the PR with this change :)

@asmeurer
Copy link
Member

I think it is a good idea, please make the PR with this change :)

#364

kgryte pushed a commit that referenced this pull request Jan 11, 2022
@asmeurer
Copy link
Member

Everything looks good here except for this question #345 (comment).

@asmeurer asmeurer merged commit d446b85 into data-apis:main Jan 24, 2022
@kgryte kgryte deleted the creation_functions-rst branch February 18, 2023 10:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Maintenance Bug fix, typo fix, or general maintenance.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants