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.

Sign up for GitHub

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

Jump to bottom

(DOCSP-11396): Update Tables page #64

Merged
merged 6 commits into from
Jul 30, 2020
Merged

(DOCSP-11396): Update Tables page #64

merged 6 commits into from
Jul 30, 2020

Conversation

melissamahoney-mongodb
Copy link
Contributor

@atsansone atsansone added copy review Review for language, format, and structure feature Merge to Feature Branch labels Jul 29, 2020
atsansone
atsansone suggested changes Jul 29, 2020
View reviewed changes
Copy link
Contributor

@atsansone atsansone left a comment

Choose a reason for hiding this comment

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

A few tweaks.

source/style-guide/style/tables.txt Outdated
Comment on lines 46 to 43
closely associated with the surrounding text and don't require titles.
For example, decision matrixes and tables within tasks, procedures, and
tutorials don't require numbers or titles.
Tables in conceptual topics should normally have titles (captions). However, some tables are closely associated with the surrounding text and don't require titles. For example, decision matrixes and tables within tasks, procedures, and tutorials don't require titles.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
closely associated with the surrounding text and don't require titles.
For example, decision matrixes and tables within tasks, procedures, and
tutorials don't require numbers or titles.
Tables in conceptual topics should normally have titles (captions). However, some tables are closely associated with the surrounding text and don't require titles. For example, decision matrixes and tables within tasks, procedures, and tutorials don't require titles.
Tables in conceptual topics should normally have titles (captions). If
you preface a table with a sentence explaining the purpose of the
table, your table doesn't require titles. For example, decision
matrixes and tables within tasks, procedures, and tutorials don't
require titles.

source/style-guide/style/tables.txt Outdated Show resolved Hide resolved
source/style-guide/style/tables.txt Outdated Show resolved Hide resolved
source/style-guide/style/tables.txt Outdated Show resolved Hide resolved
atsansone
atsansone suggested changes Jul 30, 2020
View reviewed changes
Copy link
Contributor

@atsansone atsansone left a comment

Choose a reason for hiding this comment

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

A few tweaks.

source/style-guide/style/tables.txt Show resolved Hide resolved
source/style-guide/style/tables.txt Outdated Show resolved Hide resolved
source/style-guide/style/tables.txt Outdated Show resolved Hide resolved
@melissamahoney-mongodb
(DOCSP-11396): Update Tables page
dec5f68
@melissamahoney-mongodb @atsansone
Apply suggestions from code review
6c6bd79 
Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>
@melissamahoney-mongodb
copy review
ccd5526
@melissamahoney-mongodb @atsansone
Apply suggestions from code review
e491701 
Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>
@melissamahoney-mongodb melissamahoney-mongodb mentioned this pull request Jul 30, 2020
Open
atsansone
atsansone approved these changes Jul 30, 2020
View reviewed changes
Copy link
Contributor

@atsansone atsansone left a comment

Choose a reason for hiding this comment

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

LGTM.

@melissamahoney-mongodb melissamahoney-mongodb merged commit ef66525 into mongodb:style-guide-v3 Jul 30, 2020
atsansone added a commit to atsansone/docs-meta that referenced this pull request Aug 4, 2020
@melissamahoney-mongodb @atsansone
(DOCSP-11396): Update Tables page (mongodb#64)
75ffd49 
* (DOCSP-11396): Update Tables page

* Apply suggestions from code review

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>

* copy review

* Apply suggestions from code review

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>

* copy review 2

* Fix build error from recent merge

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>
atsansone added a commit that referenced this pull request Aug 4, 2020
@melissamahoney-mongodb @atsansone
(DOCSP-11396): Update Tables page (#64)
4e66d59 
* (DOCSP-11396): Update Tables page

* Apply suggestions from code review

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>

* copy review

* Apply suggestions from code review

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>

* copy review 2

* Fix build error from recent merge

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>
atsansone added a commit to atsansone/docs-meta that referenced this pull request Aug 4, 2020
@melissamahoney-mongodb @atsansone
(DOCSP-11396): Update Tables page (mongodb#64)
461ee8d 
* (DOCSP-11396): Update Tables page

* Apply suggestions from code review

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>

* copy review

* Apply suggestions from code review

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>

* copy review 2

* Fix build error from recent merge

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>
atsansone added a commit to atsansone/docs-meta that referenced this pull request Aug 4, 2020
@melissamahoney-mongodb @atsansone
(DOCSP-11396): Update Tables page (mongodb#64)
5f5c5fc 
* (DOCSP-11396): Update Tables page

* Apply suggestions from code review

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>

* copy review

* Apply suggestions from code review

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>

* copy review 2

* Fix build error from recent merge

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>
atsansone added a commit to atsansone/docs-meta that referenced this pull request Aug 4, 2020
@melissamahoney-mongodb @atsansone
(DOCSP-11396): Update Tables page (mongodb#64)
000c8dd 
* (DOCSP-11396): Update Tables page

* Apply suggestions from code review

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>

* copy review

* Apply suggestions from code review

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>

* copy review 2

* Fix build error from recent merge

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>
atsansone added a commit to atsansone/docs-meta that referenced this pull request Aug 4, 2020
@melissamahoney-mongodb @atsansone
(DOCSP-11396): Update Tables page (mongodb#64)
4012450 
* (DOCSP-11396): Update Tables page

* Apply suggestions from code review

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>

* copy review

* Apply suggestions from code review

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>

* copy review 2

* Fix build error from recent merge

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>
atsansone added a commit to atsansone/docs-meta that referenced this pull request Aug 4, 2020
@melissamahoney-mongodb @atsansone
(DOCSP-11396): Update Tables page (mongodb#64)
e33cb96 
* (DOCSP-11396): Update Tables page

* Apply suggestions from code review

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>

* copy review

* Apply suggestions from code review

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>

* copy review 2

* Fix build error from recent merge

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>
atsansone added a commit to atsansone/docs-meta that referenced this pull request Aug 4, 2020
@melissamahoney-mongodb @atsansone
(DOCSP-11396): Update Tables page (mongodb#64)
fa3e1fb 
* (DOCSP-11396): Update Tables page

* Apply suggestions from code review

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>

* copy review

* Apply suggestions from code review

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>

* copy review 2

* Fix build error from recent merge

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>
atsansone added a commit that referenced this pull request Aug 4, 2020
@melissamahoney-mongodb @atsansone
(DOCSP-11396): Update Tables page (#64)
9c389f9 
* (DOCSP-11396): Update Tables page

* Apply suggestions from code review

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>

* copy review

* Apply suggestions from code review

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>

* copy review 2

* Fix build error from recent merge

Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@atsansone atsansone atsansone approved these changes

Assignees
No one assigned
Labels
copy review Review for language, format, and structure feature Merge to Feature Branch
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@melissamahoney-mongodb @atsansone