FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Document the order of cells within a row. by coryan · Pull Request #146 · googleapis/google-cloud-cpp · GitHub

Document the order of cells within a row. - #146

Merged
mbrukman merged 3 commits into
googleapis:masterfrom
coryan:document-order-of-cells
Dec 28, 2017
Merged

Document the order of cells within a row.#146
mbrukman merged 3 commits into
googleapis:masterfrom
coryan:document-order-of-cells

Conversation

coryan commented Dec 26, 2017

Copy link
Copy Markdown
Contributor

Such as it is (the order is not guaranteed for column families).
This fixes #82.

Such as it is (the order is not guaranteed for column families).
This fixes googleapis#82.
googlebot added the cla: yes This human has signed the Contributor License Agreement. label Dec 26, 2017
coryan requested review from carterpage and garye December 26, 2017 14:47
Comment thread bigtable/client/filters.h Outdated
* by:
* - The column family internal ID, which is not necessarily the
* lexicographical order of the column family names. Also, the ID of each
* column family may change on each row.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I'm not quite sure how to parse this. Is there a way to rephrase? Overall the description seems accurate, though.

Even though these are only comment changes I am not skipping the
CI build because they affect Doxygen.

coryan commented Dec 26, 2017

Copy link
Copy Markdown
Contributor Author

PTAL.

Comment thread bigtable/client/filters.h
* filter apples to the cells within a row, if there are multiple column
* families and/or columns in a row the order is:
* - All the cells for a column family appear together, but there is no
* guarantee on the order of the column families. Furthermore, column

carterpage Dec 28, 2017
edited
Loading

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Removing the "internal ID" reference is an improvement. It is best to avoid referring to internal mechanics that the user can't see.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Certainly.

Comment thread bigtable/client/filters.h
* of multiple filters via the `Interleave()` function. Furthermore, this
* filter apples to the cells within a row, if there are multiple column
* families and/or columns in a row the order is:
* - All the cells for a column family appear together, but there is no

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Have you checked the rendering of this in Doxygen output? Doxygen supports Markdown, but most Markdown parsers I've seen require adding a blank line before a bulleted list; otherwise, it doesn't render properly.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Yes, see below.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM, thanks for checking.

Comment thread bigtable/client/filters.h
* of multiple filters via the `Interleave()` function. Furthermore, this
* filter apples to the cells within a row, if there are multiple column
* families and/or columns in a row the order is:
* - All the cells for a column family appear together, but there is no

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Same comment about rendering as above.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I did, it works. Look at the attached file:

filter-doxygen-render.pdf

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Perfect, thanks!

coryan commented Dec 28, 2017

Copy link
Copy Markdown
Contributor Author

PTAL.

Comment thread bigtable/client/filters.h Outdated
* - All the cells for a column family appear together, but there is no
* guarantee on the order of the column families. Furthermore, column
* families may appear in different orders in different rows.
* - Within a column family the cells are ordered by column name, column names

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality
  • Within a column family, the cells are ordered by column name, where column names are sorted lexicographically.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Fixed.

Comment thread bigtable/client/filters.h Outdated
* families may appear in different orders in different rows.
* - Within a column family the cells are ordered by column name, column names
* are compared lexicographically.
* - With a column, the cells appear in descending order by timestamp.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

s/With/Within/

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Fixed.

Comment thread bigtable/client/filters.h Outdated
* families may appear in different orders in different rows.
* - Within a column family the cells are ordered by column name, column names
* are compared lexicographically.
* - With a column, the cells appear in descending order by timestamp.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

s/With/Within/

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Fixed.

Comment thread bigtable/client/filters.h Outdated
* TODO(#82) - check the documentation around ordering of columns.
* Note that cells might be repeated, such as when interleaving the results
* of multiple filters via the `Interleave()` function. Furthermore, this
* filter apples to the cells within a row, if there are multiple column

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

s/row, if/row; if/

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Fixed.

Comment thread bigtable/client/filters.h Outdated
* Note that cells might be repeated, such as when interleaving the results
* of multiple filters via the `Interleave()` function. Furthermore, this
* filter apples to the cells within a row, if there are multiple column
* families and/or columns in a row the order is:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

s/row the/row, the/

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Fixed.

Comment thread bigtable/client/filters.h Outdated
* - All the cells for a column family appear together, but there is no
* guarantee on the order of the column families. Furthermore, column
* families may appear in different orders in different rows.
* - Within a column family the cells are ordered by column name, column names

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality
  • Within a column family, the cells are ordered by column name, where column names are sorted lexicographically.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thanks!

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Fixed.

Comment thread bigtable/client/filters.h Outdated
* TODO(#82) - check the documentation around ordering of columns.
* Note that cells might be repeated, such as when interleaving the results
* of multiple filters via the `Interleave()` function. Furthermore, this
* filter apples to the cells within a row, if there are multiple column

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

s/row, if/row; if/

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Fixed, this is identical to the previous comment, so I just copied it.

Comment thread bigtable/client/filters.h Outdated
* Note that cells might be repeated, such as when interleaving the results
* of multiple filters via the `Interleave()` function. Furthermore, this
* filter apples to the cells within a row, if there are multiple column
* families and/or columns in a row the order is:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

s/row the/row, the/

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Fixed.

coryan commented Dec 28, 2017

Copy link
Copy Markdown
Contributor Author

PTAL.
I did not skip the ci build because Doxygen, though I expect no breakage.

mbrukman left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM

mbrukman merged commit bfdd4dc into googleapis:master Dec 28, 2017
coryan deleted the document-order-of-cells branch December 28, 2017 20:08
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla: yes This human has signed the Contributor License Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document order of cells returned by ReadRows() within a row.

5 participants


Back | FazBrowse Home | New Git URL