Skip to content

C API documentation index is laid out incorrectly #105196

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
iritkatriel opened this issue Jun 1, 2023 · 13 comments
Closed

C API documentation index is laid out incorrectly #105196

iritkatriel opened this issue Jun 1, 2023 · 13 comments
Labels
docs Documentation in the Doc dir easy topic-C-API type-bug An unexpected behavior, bug, or error

Comments

@iritkatriel
Copy link
Member

iritkatriel commented Jun 1, 2023

The last two lines in this snippet should be indented further than the line above them, they are more specific.
(Alternatively, they can be removed because they don't add much).

image

Linked PRs

@iritkatriel iritkatriel added type-bug An unexpected behavior, bug, or error docs Documentation in the Doc dir labels Jun 1, 2023
@hugovk hugovk added the easy label Jun 1, 2023
@rhettinger
Copy link
Contributor

I would just fix the indentation on the last two. Then, I would check to make sure the link targets are unchanged so that external links into our docs aren't broken.

@iritkatriel
Copy link
Member Author

I think Ellipsis should be indented under slice as well:

image

@iritkatriel
Copy link
Member Author

iritkatriel commented Jun 1, 2023

And internal frames under frame objects:

image

@safwansamsudeen
Copy link

safwansamsudeen commented Jun 9, 2023

Hey, I'm new here, would love to contribute to Python!

It's not much of a fix, but can I work on this?

If so, which file is this?

@roy9495
Copy link
Contributor

roy9495 commented Jun 10, 2023

Hi, I made the indentation changes in these two files Doc/build/html/contents.html, Doc/build/html/c-api/concrete.html respectively but these files are untracked so when I am trying to commit the commit is becoming too large.
Any guidance you can give me will be helpful.

@safwansamsudeen
Copy link

@roy9495, were you assigned to this?

@roy9495
Copy link
Contributor

roy9495 commented Jun 10, 2023

@safwansamsudeen No, I was not assigned. Sorry, I should have asked first.

@iritkatriel
Copy link
Member Author

We don’t assign issues to contributors.

The way it goes is that if you want to work on an issue you leave a comment about that, and if there is such a comment by someone else, and it’s a fairly recent comment, you let them work on it. If it’s an older comment you should ask them if they are still working on it, and if they don’t reply within a reasonable amount of time you can leave a comment to indicate that you are working on it.

So basically, we communicate our intentions on the issue.

@roy9495
Copy link
Contributor

roy9495 commented Jun 11, 2023

@safwansamsudeen Are you still working on this?

@safwansamsudeen
Copy link

@roy9495 I didn't start it. If you're working on it, that's cool! If you're busy, I'll take it up.

@safwansamsudeen
Copy link

safwansamsudeen commented Jun 12, 2023

@safwansamsudeen No, I was not assigned. Sorry, I should have asked first.

Ahh @roy9495 I'm sorry, I misread the conversation. My first comment on this issue indicated that I wanted to work on this, and I interpreted your comment to be disregarding mine and working on it instead... which is why I asked if you were assigned to it.

I now see you were responding to my request of help, ugh. Thanks, and do accept my apologies for my coldness in my second comment! And great work on the PR!

@roy9495
Copy link
Contributor

roy9495 commented Jun 13, 2023

@safwansamsudeen Thank you, Please don't apologise.

@CAM-Gerlach CAM-Gerlach changed the title c-api documentation index is laid out incorrectly C API documentation index is laid out incorrectly Jun 14, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Jun 14, 2023
CAM-Gerlach pushed a commit that referenced this issue Jun 15, 2023
…H-105672) (#105782)

gh-105196: Fix indentations of section headings in C API docs (GH-105672)
(cherry picked from commit d32e8d6)

Co-authored-by: TATHAGATA ROY <[email protected]>
CAM-Gerlach pushed a commit that referenced this issue Jun 15, 2023
…105672) (#105786)

gh-105196: Fix indentations of section headings in C API docs (#105672)

Co-authored-by: TATHAGATA ROY <[email protected]>
@CAM-Gerlach
Copy link
Member

PR and all backports merged, so closing this now. Thanks @roy9495 and @iritkatriel!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir easy topic-C-API type-bug An unexpected behavior, bug, or error
Projects
None yet
Development

No branches or pull requests

7 participants