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.

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

Doc items breaking into groups by first sentence rather than alphabetically #35347

Closed
Chaosus opened this issue Jan 20, 2020 · 9 comments
Closed

Comments

@Chaosus
Copy link
Member

Chaosus commented Jan 20, 2020

Godot version:
3.1 - 3.2rc1

Issue description:
Looks like incorrect spacing where it shouldn't and not breaking where it should:
image

@Chaosus
Copy link
Member Author

Chaosus commented Jan 20, 2020

Ah, maybe it's just a matter of taste... They are grouped by first sub-sentence rather than alphabetically, which may be ok.

@Chaosus Chaosus changed the title Doc items incorrectly breaking into groups Doc items breaking into groups by first sentence rather than alphabetically Jan 20, 2020
@mdante97
Copy link

Hi, I would like to take on this issue, but not exactly sure on how assigning these work. I would be happy in helping to sort out the doc items alphabetically.

@Calinou
Copy link
Member

Calinou commented Mar 12, 2020

@mdante97 I think the current way of sorting is fine. It's already alphabetical, it just happens to group results by their first sub-sentence like distance or is_.

This issue can probably be closed.

@akien-mga
Copy link
Member

I think the grouping by prefix similarity could simply be removed now. I assume it was done back in the days when we didn't have properties and had dozens of set_, get_ and is_ methods. This is no longer the case so I think the prefix grouping is rarely meaningful.

@Anukriti12
Copy link

Anukriti12 commented Mar 12, 2020

Removing additional newline command in editor_help.cpp at line 655 (inside if condition) should do it.
I'm not sure how exactly should I make a pull request now that master branch is unstable (https://godotengine.org/article/headsup-vulkan-merged-master-branch-unstable)

Anukriti12 added a commit to Anukriti12/godot that referenced this issue Mar 13, 2020
@Calinou
Copy link
Member

Calinou commented Apr 14, 2020

@Anukriti12 Feel free to open a pull request right away; you can rebase it in the future if it gets conflicts due to refactorings. I believe editor-related refactorings have mostly been completed by now (especially for parts that could affect the editor help).

@ChristopheLY
Copy link
Contributor

@Anukriti12 without newline, it's hard to read and find a method when they are a lot.

@ChristopheLY
Copy link
Contributor

something else, if we break by alphabetically the section Methods, we need to do the same for Properties which above Methods for the same reason

@Chaosus
Copy link
Member Author

Chaosus commented Oct 18, 2024

I think this looks okayish now (compared to the original screenshot):

изображение

@Chaosus Chaosus closed this as completed Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants