MAINT, BUG: Final 1.14 formatting fixes #10177
Conversation
Missed in numpygh-10176. Already in the non-legacy branch, so no need to gate it here.
doc/release/1.14.0-notes.rst
Outdated
| elements. | ||
| * The last line of an array string will never have more elements than earlier | ||
| lines. | ||
| * To summarization, the use of ``...`` to shorten long arrays: |
There was a problem hiding this comment.
I want the noun form here, since the other list items are nouns.
There was a problem hiding this comment.
"to noun" doesn't read right, "to nounize" does, even though "nounize" isn't a word ;)
There was a problem hiding this comment.
This was intended to be read as "the changes are" ... "to summarization", which reads just fine. But perhaps that kind of continuation from list heading to item is confusing. I've replaced all of the "to" s with "for" s
doc/release/1.14.0-notes.rst
Outdated
| and now instead show the shortest unique representation. | ||
| * The ``str`` of floating-point scalars is no longer truncated in python2. | ||
| * Non-finite complex scalars print like ``nanj`` instead of ``nan*j``. | ||
| * To floating-point types: |
There was a problem hiding this comment.
Indenting the list results in a line down the left hand side when rendered for documentation , which is why it wasn't indented before. The sublists need to be separated by blank lines. If you view the file you can see some of these problems.
There was a problem hiding this comment.
Generally, "to" should be replaced by "for".
There was a problem hiding this comment.
Thanks for reminding me that github can render RST files.
doc/release/1.14.0-notes.rst
Outdated
| * Float arrays printed in scientific notation no longer use fixed-precision, | ||
| and now instead show the shortest unique representation. | ||
| * The ``str`` of floating-point scalars is no longer truncated in python2. | ||
| * To other data types: |
There was a problem hiding this comment.
I used "to" for consistency with the other headings
doc/release/1.14.0-notes.rst
Outdated
| * To summarization, the use of ``...`` to shorten long arrays: | ||
| * A trailing comma is no longer inserted for ``str``. | ||
| Previously, ``str(np.arange(1001))`` gave | ||
| ``'[ 0 1 2 ..., 998 999 1000]'``, which has an extra comma. |
There was a problem hiding this comment.
NVM, I think "which" is correct here.
doc/release/1.14.0-notes.rst
Outdated
| * A trailing comma is no longer inserted for ``str``. | ||
| Previously, ``str(np.arange(1001))`` gave | ||
| ``'[ 0 1 2 ..., 998 999 1000]'``, which has an extra comma. | ||
| * For arrays of 2-d and beyond, the ``...`` printed on its own line to |
There was a problem hiding this comment.
"is printed"? Missing period after "line".
There was a problem hiding this comment.
Nope, this is deliberate
doc/release/1.14.0-notes.rst
Outdated
| Previously, ``str(np.arange(1001))`` gave | ||
| ``'[ 0 1 2 ..., 998 999 1000]'``, which has an extra comma. | ||
| * For arrays of 2-d and beyond, the ``...`` printed on its own line to | ||
| summarize all but the last axis now has trailing newlines added to match |
There was a problem hiding this comment.
Also disagree here. "summarize all but the last axis" is the clause I want
doc/release/1.14.0-notes.rst
Outdated
| ``'[ 0 1 2 ..., 998 999 1000]'``, which has an extra comma. | ||
| * For arrays of 2-d and beyond, the ``...`` printed on its own line to | ||
| summarize all but the last axis now has trailing newlines added to match | ||
| the leading newlines, and the trailing space character removed. |
There was a problem hiding this comment.
Not convinced - "the ... on its own line has the trailing space character removed". Perhaps "has" should be repeated for the second item, "and has the trailing space character removed".
There was a problem hiding this comment.
The sentence is hard to read, I would just rework it somehow . Maybe
For arrays of 2-d and beyond, when
...is printed on its own line to summarize any but the last axis, trailing newlines are now added to match the leading newlines, and the trailing space character is removed.
There was a problem hiding this comment.
To me, that seems to imply the newlines are added to the array, not to the ...
There was a problem hiding this comment.
Parenthesize "(to summarize all but the last axis)"?
There was a problem hiding this comment.
For arrays of 2-d and beyond, when
...is printed on its own line in order to summarize any but the last axis, newlines are now appended to that line to match its leading newlines, and a trailing space character is removed.
?
There was a problem hiding this comment.
Sounds good. Can you fix up?
|
The release notes need fixing up. |
|
Formatting and To/for fixed. Can I get you to make any remaining fixups (I didn't see the latest comments until after I committed). I'm not sure your remaining corrections are valid anyway |
|
LGTM except that sentence. |
|
Thanks Eric. |
|
So when is 1.14.0 scheduled to be released? Are there any RCs planned? Is there an issue I should be following for this sort of stuff? |
|
@jakirkham I will try to get an rc1 release out tomorrow. When the final comes out will depend on how things go from there, but I wouldn't expect it to be out until Jan. |
|
Ok, well please ping me when the RC comes out. I'd like to put the dev package on |
Follows on from gh-10176, and does the missed release notes edit for that and some other PRs.
Also tries to group the changes together in the release notes.