Skip to content

Update array-operators.md #1698

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

Closed
wants to merge 2 commits into from
Closed

Conversation

drvoss
Copy link
Contributor

@drvoss drvoss commented Nov 10, 2019

fix a better match in meaning

@PRMerger9
Copy link
Contributor

@drvoss : Thanks for your contribution! The author(s) have been notified to review your proposed change.

@PRMerger9
Copy link
Contributor

@drvoss : Thanks for your contribution! The author(s) have been notified to review your proposed change.

@ShannonLeavitt ShannonLeavitt added the aq-pr-triaged Tracking label for the PR review team label Nov 11, 2019
Copy link
Contributor

@colin-home colin-home left a comment

Choose a reason for hiding this comment

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

@drvoss
This doesn't look quite right. Normally, we reserve bold styling for language keywords and UI elements. In this case, since the descriptions aren't complete sentences, it's hard to tell if Array is being used in a generic sense or as a type. If it's the type, the preferred style is array, written in markdown wrapped in `back-ticks`. If it's generic, then array should be unstyled.

The best solution might be to turn these descriptions into sentences, so it's easy to tell. For example:

Operator <=

A non-member operator function that lexicographically compares the contents of two array objects. It returns true if the left argument compares as less than or equal to the right argument.

@ktoliver
Copy link
Contributor

ktoliver commented Feb 7, 2020

Hi @drvoss - Could you review the feedback and respond as we review your PR? Thanks.

@drvoss drvoss closed this Feb 12, 2020
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.

5 participants