Skip to content

DOC: Preliminary edit of 1.13.0 release notes. #8847

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.

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

Merged
merged 1 commit into from
Mar 27, 2017

Conversation

charris
Copy link
Member

@charris charris commented Mar 26, 2017

[ci skip]

@charris
Copy link
Member Author

charris commented Mar 26, 2017

This is a first pass. I'd like it in now so that anything new that goes in will conform.

Hmm, it seems that neither PyArray_MapIterArrayCopyIfOverlap nor older functions such as PyArray_MapIterArray are documented in the official documentation. Anyone know if there is other documentation out there? We really need to make sure the C-API is documented.

Error type changes
~~~~~~~~~~~~~~~~~~
Copy link
Member

Choose a reason for hiding this comment

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

1.11, 1.10, 1.9, 1.8, and probably more, all used tildes for these headings. 1.12 is the outlier, not 1.13

Copy link
Member Author

@charris charris Mar 27, 2017

Choose a reason for hiding this comment

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

It's not dashes the outlier, it's dashes, a new hope.

I introduced tildes back when to solve one rendering problem, and now that we are releasing on github, dashes for subtitles and stars for lists gives us better markdown compatibility.

Copy link
Member

Choose a reason for hiding this comment

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

Note that we have a regression in #8845 here, which was merged at just the wrong time

@rgommers
Copy link
Member

Anyone know if there is other documentation out there?

Don't think so. There are more issues about things missing from the C API docs.

We really need to make sure the C-API is documented.

What we need is an automated way to check that every public function (Python and C) is present in the reference guide. Otherwise we'll keep missing this. We have this for scipy here, would be good to copy that and extend for the C API.

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.

3 participants