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

[Docs][Specifications] Is this intentional or a typo? #38599

Closed
llama90 opened this issue Nov 6, 2023 · 2 comments · Fixed by #38696
Closed

[Docs][Specifications] Is this intentional or a typo? #38599

llama90 opened this issue Nov 6, 2023 · 2 comments · Fixed by #38696
Assignees
@llama90
Labels
Component: Documentation Type: bug
Milestone
15.0.0

Comments

@llama90
Copy link
Contributor

llama90 commented Nov 6, 2023 •
edited
Loading

Describe the bug, including details regarding any error messages, version, and platform.

The document for Device Stream Interface shows the heading at Level 1, but it is not included in Section Navigation.

Is this intentional? If it's intentional, shouldn't the heading level for this content be Level 2? If it's not intentional, is it okay to adjust it to be positioned independently between The Arrow C Device data interface and Arrow Flight RPC?

image

Component(s)

Documentation
@kou
Copy link
Member

kou commented Nov 7, 2023

I think that we should use level 2 for "Device Stream Interface" and sub sections in it or use separated page like https://arrow.apache.org/docs/format/CDataInterface.html and https://arrow.apache.org/docs/format/CStreamInterface.html .
@zeroshade What do you think about this?

@zeroshade
Copy link
Member

Hmm, I think I agree that it would make sense for "Device Stream Interface" to use level 2 as it is technically a sub-level to the regular C Data Interface itself. I don't think it would be beneficial for them to be separate pages

@github-actions github-actions bot mentioned this issue Nov 13, 2023
Merged
pitrou pushed a commit that referenced this issue Nov 15, 2023
@llama90
GH-38599: [Docs] Update Headers (#38696)
cc627ee 
### Rationale for this change

Noticed wrong section headings on the web doc and proposing a fix.

### Are these changes tested?

Yes. Built and verified the documentation locally.

<img width="1049" alt="image" src="https://github.com/apache/arrow/assets/6668548/793d6222-2bc5-4f55-ab67-5abe5283add4">

### Are there any user-facing changes?

No.
* Closes: #38599

Authored-by: Hyunseok Seo <hsseo0501@gmail.com>
Signed-off-by: Antoine Pitrou <antoine@python.org>
@pitrou pitrou added this to the 15.0.0 milestone Nov 15, 2023
dgreiss pushed a commit to dgreiss/arrow that referenced this issue Feb 19, 2024
@llama90 @dgreiss
apacheGH-38599: [Docs] Update Headers (apache#38696)
a1a7de1 
### Rationale for this change

Noticed wrong section headings on the web doc and proposing a fix.

### Are these changes tested?

Yes. Built and verified the documentation locally.

<img width="1049" alt="image" src="https://github.com/apache/arrow/assets/6668548/793d6222-2bc5-4f55-ab67-5abe5283add4">

### Are there any user-facing changes?

No.
* Closes: apache#38599

Authored-by: Hyunseok Seo <hsseo0501@gmail.com>
Signed-off-by: Antoine Pitrou <antoine@python.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@llama90 llama90

Labels
Component: Documentation Type: bug
Projects
None yet
Milestone
15.0.0
Development

Successfully merging a pull request may close this issue.

GH-38599: [Docs] Update Headers llama90/arrow
4 participants
@kou @zeroshade @pitrou @llama90