Skip to content
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

[numarray] Wildly inconsistent formatting for valarray helpers #2023

Closed
jwakely opened this issue Apr 5, 2018 · 7 comments
Closed

[numarray] Wildly inconsistent formatting for valarray helpers #2023

jwakely opened this issue Apr 5, 2018 · 7 comments
Assignees

Comments

@jwakely
Copy link
Member

jwakely commented Apr 5, 2018

There are a number of apparently unnecessary inconsistencies between [template.slice.array.overview], [template.gslice.array.overview], [template.mask.array.overview], and [template.indirect.array.overview].

[template.slice.array.overview] p1 says:

The slice_array template is a helper template used by the slice subscript operator

slice_array<T> valarray<T>::operator[](slice);

And [template.gslice.array.overview] p1 says:

This template is a helper template used by the slice subscript operator

gslice_array<T> valarray<T>::operator[](const gslice&);

Either the latter should say "gslice subscript operator" or the word slice should not be in code font (which would be consistent with "mask subscript operator" and "indirect subscript operator" in [template.mask.array.overview] and [template.indirect.array.overview] respectively).

Also [template.slice.array.overview] p1 says "The slice_array template is a helper template" but the other three helpers say "This template is a helper template". Presumably they could be consistent.

The "It has reference semantics ..." wording is part of p1 in [template.slice.array.overview] but is a separate paragraph p2 in the other three places.

The explanation of the effects ("the expression ... has the effect of ...") is an Example: in [template.slice.array.overview], its own paragraph in [template.gslice.array.overview], and part of p2 in [template.mask.array.overview] and [template.indirect.array.overview].

@jwakely
Copy link
Member Author

jwakely commented Apr 5, 2018

Some of those paragraphs were also incorrectly indented, but I've fixed that in c9e60ab

@jwakely jwakely changed the title Formatting of "slice subscript operator" Wildly inconsistent formatting for valarray helpers Apr 5, 2018
@GabrielDosReis
Copy link

This template is a helper template used by the slice subscript operator

It should be gslice.

@jwakely
Copy link
Member Author

jwakely commented Apr 6, 2018

Thanks!

@jensmaurer
Copy link
Member

So, we're actually repairing valarray wording? Shocking.

@jensmaurer jensmaurer changed the title Wildly inconsistent formatting for valarray helpers [numarray] Wildly inconsistent formatting for valarray helpers Apr 6, 2018
@jensmaurer jensmaurer self-assigned this Apr 8, 2018
@jwakely
Copy link
Member Author

jwakely commented Apr 16, 2018

Does anybody except me care about the other inconsistencies?

The "It has reference semantics ..." wording is part of p1 in [template.slice.array.overview] but is a separate paragraph p2 in the other three places.

The explanation of the effects ("the expression ... has the effect of ...") is an Example: in [template.slice.array.overview], its own paragraph in [template.gslice.array.overview], and part of p2 in [template.mask.array.overview] and [template.indirect.array.overview].

@jwakely jwakely reopened this Apr 16, 2018
@jwakely
Copy link
Member Author

jwakely commented Apr 16, 2018

I can send a pull request if we agree which presentation to use.

@jensmaurer
Copy link
Member

@jwakely: "The "It has reference semantics ..." wording is part of p1 in [template.slice.array.overview] but is a separate paragraph p2 in the other three places." This has been addressed in the patch; it's p2 as well, now.

"The explanation of the effects ("the expression ... has the effect of ...") is an Example: in [template.slice.array.overview]," Addressing this would mean adding normative wording to an underspecified facility -> LWG issue, I'd say.

I agree with merging p3 in [template.gslice.array.overview] with its preceding paragraph for consistency.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants