Skip to content

[Data][Docs] Fix inconsistent heading levels in "How to write tests" guide#60706

Merged
bveeramani merged 2 commits intoray-project:masterfrom
yuhuan130:fix-docs-heading-levels
Feb 4, 2026
Merged

[Data][Docs] Fix inconsistent heading levels in "How to write tests" guide#60706
bveeramani merged 2 commits intoray-project:masterfrom
yuhuan130:fix-docs-heading-levels

Conversation

@yuhuan130
Copy link
Contributor

Description

This PR fixes inconsistent heading levels in the Ray Data "How to write tests" documentation guide.

Three sections under "Ray-specific practices" were incorrectly using H2 (##) headings instead of H3 (###) headings. This fix improves document structure, navigation, and table of contents rendering.

Changes made:

  • "Avoid testing against repr outputs to validate specific data"
  • "Avoid assumptions about the number or size of blocks"
  • "Avoid testing that the DAG looks a particular way"

Related issues

Fixes #60699

Signed-off-by: “Alex <alexchien130@gmail.com>
@yuhuan130 yuhuan130 requested a review from a team as a code owner February 3, 2026 12:02
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request correctly fixes inconsistent heading levels in the "How to write tests" documentation guide. The changes from H2 to H3 for three sections under "Ray-specific practices" improve the document's structure and readability. The changes are accurate and I approve of them.

@ray-gardener ray-gardener bot added docs An issue or change related to documentation data Ray Data-related issues community-contribution Contributed by the community labels Feb 3, 2026
@yuhuan130
Copy link
Contributor Author

@bveeramani @owenowenisme PTAL TY

Copy link
Member

@bveeramani bveeramani left a comment

Choose a reason for hiding this comment

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

Nice

@bveeramani bveeramani enabled auto-merge (squash) February 4, 2026 17:49
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label Feb 4, 2026
@bveeramani bveeramani merged commit 18facf8 into ray-project:master Feb 4, 2026
8 checks passed
tiennguyentony pushed a commit to tiennguyentony/ray that referenced this pull request Feb 7, 2026
…guide (ray-project#60706)

## Description

This PR fixes inconsistent heading levels in the Ray Data "How to write
tests" documentation guide.

Three sections under "Ray-specific practices" were incorrectly using H2
(`##`) headings instead of H3 (`###`) headings. This fix improves
document structure, navigation, and table of contents rendering.

**Changes made:**
- "Avoid testing against repr outputs to validate specific data"
- "Avoid assumptions about the number or size of blocks"
- "Avoid testing that the DAG looks a particular way"

## Related issues

Fixes ray-project#60699

Signed-off-by: “Alex <alexchien130@gmail.com>
Signed-off-by: tiennguyentony <46289799+tiennguyentony@users.noreply.github.com>
tiennguyentony pushed a commit to tiennguyentony/ray that referenced this pull request Feb 7, 2026
…guide (ray-project#60706)


## Description

This PR fixes inconsistent heading levels in the Ray Data "How to write
tests" documentation guide.

Three sections under "Ray-specific practices" were incorrectly using H2
(`##`) headings instead of H3 (`###`) headings. This fix improves
document structure, navigation, and table of contents rendering.

**Changes made:**
- "Avoid testing against repr outputs to validate specific data"
- "Avoid assumptions about the number or size of blocks"
- "Avoid testing that the DAG looks a particular way"

## Related issues

Fixes ray-project#60699

Signed-off-by: “Alex <alexchien130@gmail.com>
Signed-off-by: tiennguyentony <46289799+tiennguyentony@users.noreply.github.com>
tiennguyentony pushed a commit to tiennguyentony/ray that referenced this pull request Feb 7, 2026
…guide (ray-project#60706)


## Description

This PR fixes inconsistent heading levels in the Ray Data "How to write
tests" documentation guide.

Three sections under "Ray-specific practices" were incorrectly using H2
(`##`) headings instead of H3 (`###`) headings. This fix improves
document structure, navigation, and table of contents rendering.

**Changes made:**
- "Avoid testing against repr outputs to validate specific data"
- "Avoid assumptions about the number or size of blocks"
- "Avoid testing that the DAG looks a particular way"

## Related issues

Fixes ray-project#60699

Signed-off-by: “Alex <alexchien130@gmail.com>
Sparks0219 pushed a commit to Sparks0219/ray that referenced this pull request Feb 9, 2026
…guide (ray-project#60706)

## Description

This PR fixes inconsistent heading levels in the Ray Data "How to write
tests" documentation guide.

Three sections under "Ray-specific practices" were incorrectly using H2
(`##`) headings instead of H3 (`###`) headings. This fix improves
document structure, navigation, and table of contents rendering.

**Changes made:**
- "Avoid testing against repr outputs to validate specific data"
- "Avoid assumptions about the number or size of blocks"
- "Avoid testing that the DAG looks a particular way"

## Related issues

Fixes ray-project#60699

Signed-off-by: “Alex <alexchien130@gmail.com>
elliot-barn pushed a commit that referenced this pull request Feb 9, 2026
…guide (#60706)

## Description

This PR fixes inconsistent heading levels in the Ray Data "How to write
tests" documentation guide.

Three sections under "Ray-specific practices" were incorrectly using H2
(`##`) headings instead of H3 (`###`) headings. This fix improves
document structure, navigation, and table of contents rendering.

**Changes made:**
- "Avoid testing against repr outputs to validate specific data"
- "Avoid assumptions about the number or size of blocks"
- "Avoid testing that the DAG looks a particular way"

## Related issues

Fixes #60699

Signed-off-by: “Alex <alexchien130@gmail.com>
Signed-off-by: elliot-barn <elliot.barnwell@anyscale.com>
elliot-barn pushed a commit that referenced this pull request Feb 9, 2026
…guide (#60706)

## Description

This PR fixes inconsistent heading levels in the Ray Data "How to write
tests" documentation guide.

Three sections under "Ray-specific practices" were incorrectly using H2
(`##`) headings instead of H3 (`###`) headings. This fix improves
document structure, navigation, and table of contents rendering.

**Changes made:**
- "Avoid testing against repr outputs to validate specific data"
- "Avoid assumptions about the number or size of blocks"
- "Avoid testing that the DAG looks a particular way"

## Related issues

Fixes #60699

Signed-off-by: “Alex <alexchien130@gmail.com>
ans9868 pushed a commit to ans9868/ray that referenced this pull request Feb 18, 2026
…guide (ray-project#60706)

## Description

This PR fixes inconsistent heading levels in the Ray Data "How to write
tests" documentation guide.

Three sections under "Ray-specific practices" were incorrectly using H2
(`##`) headings instead of H3 (`###`) headings. This fix improves
document structure, navigation, and table of contents rendering.

**Changes made:**
- "Avoid testing against repr outputs to validate specific data"
- "Avoid assumptions about the number or size of blocks"
- "Avoid testing that the DAG looks a particular way"

## Related issues

Fixes ray-project#60699

Signed-off-by: “Alex <alexchien130@gmail.com>
Signed-off-by: Adel Nour <ans9868@nyu.edu>
Aydin-ab pushed a commit to kunling-anyscale/ray that referenced this pull request Feb 20, 2026
…guide (ray-project#60706)

## Description

This PR fixes inconsistent heading levels in the Ray Data "How to write
tests" documentation guide.

Three sections under "Ray-specific practices" were incorrectly using H2
(`##`) headings instead of H3 (`###`) headings. This fix improves
document structure, navigation, and table of contents rendering.

**Changes made:**
- "Avoid testing against repr outputs to validate specific data"
- "Avoid assumptions about the number or size of blocks"
- "Avoid testing that the DAG looks a particular way"

## Related issues

Fixes ray-project#60699

Signed-off-by: “Alex <alexchien130@gmail.com>
peterxcli pushed a commit to peterxcli/ray that referenced this pull request Feb 25, 2026
…guide (ray-project#60706)

## Description

This PR fixes inconsistent heading levels in the Ray Data "How to write
tests" documentation guide.

Three sections under "Ray-specific practices" were incorrectly using H2
(`##`) headings instead of H3 (`###`) headings. This fix improves
document structure, navigation, and table of contents rendering.

**Changes made:**
- "Avoid testing against repr outputs to validate specific data"
- "Avoid assumptions about the number or size of blocks"
- "Avoid testing that the DAG looks a particular way"

## Related issues

Fixes ray-project#60699

Signed-off-by: “Alex <alexchien130@gmail.com>
Signed-off-by: peterxcli <peterxcli@gmail.com>
peterxcli pushed a commit to peterxcli/ray that referenced this pull request Feb 25, 2026
…guide (ray-project#60706)

## Description

This PR fixes inconsistent heading levels in the Ray Data "How to write
tests" documentation guide.

Three sections under "Ray-specific practices" were incorrectly using H2
(`##`) headings instead of H3 (`###`) headings. This fix improves
document structure, navigation, and table of contents rendering.

**Changes made:**
- "Avoid testing against repr outputs to validate specific data"
- "Avoid assumptions about the number or size of blocks"
- "Avoid testing that the DAG looks a particular way"

## Related issues

Fixes ray-project#60699

Signed-off-by: “Alex <alexchien130@gmail.com>
Signed-off-by: peterxcli <peterxcli@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community-contribution Contributed by the community data Ray Data-related issues docs An issue or change related to documentation go add ONLY when ready to merge, run all tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Data][Docs] Fix inconsistent heading levels in "How to write tests" guide

2 participants