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

Sort editor help documentation methods and properties by alphabetical order #39141

Closed
wants to merge 1 commit into from

Conversation

ChristopheLY
Copy link
Contributor

@ChristopheLY ChristopheLY commented May 29, 2020

Closes #35347.

@Calinou
Copy link
Member

Calinou commented May 29, 2020

Can you take a before/after screenshot so we can see the difference? Reading the code, I'm not sure if grouping by first letter is actually an upgrade.

@Calinou Calinou added the cherrypick:3.x Considered for cherry-picking into a future 3.x release label May 29, 2020
@realkotob
Copy link
Contributor

realkotob commented May 29, 2020

I like the change, it makes it easier to quickly navigate visually. It's definitely an ergonomic change if nothing else.

@Calinou
Copy link
Member

Calinou commented May 29, 2020

Looks good to me as well.

editor/editor_help.cpp Outdated Show resolved Hide resolved
@akien-mga
Copy link
Member

@ChristopheLY
Copy link
Contributor Author

Should I close de PR now?

@Calinou
Copy link
Member

Calinou commented Jun 4, 2020

@ChristopheLY No, it will be closed automatically when it's merged.

@ChristopheLY
Copy link
Contributor Author

may fixe, #35347

@aaronfranke
Copy link
Member

@ChristopheLY Is this still desired? If so, it needs to be rebased and tested on the latest master branch.

@YuriSizov YuriSizov requested a review from a team August 24, 2021 23:12
@YuriSizov YuriSizov changed the title editor help doc sort with space for Methods and Properties by alphabe… editor help doc sort with space for Methods and Properties by alphabetical order Sep 14, 2021
@clayjohn clayjohn modified the milestones: 4.0, 4.x Aug 9, 2022
@clayjohn clayjohn requested a review from a team August 9, 2022 12:49
@clayjohn
Copy link
Member

clayjohn commented Aug 9, 2022

Discussed in PR review. Needs review by someone knowledgeable with docs formatting. Not urgent for 4.0

@YuriSizov
Copy link
Contributor

I'm not sure if grouping by first letter is actually an upgrade.

I'm not convinced either. The API is just too varied and grouping by the first letter is bound to introduce a lot of unnecessary splitting in some classes. We could probably do something smarter, and try to separate large groups of methods based on a prefix, while grouping smaller chunks together regardless of their name.

It would be nice to fix the linked issue though. But this PR needs to be reworked against the current master.

@fire fire changed the title editor help doc sort with space for Methods and Properties by alphabetical order Sort editor help documentation methods and properties by alphabetical order Nov 21, 2024
@AThousandShips
Copy link
Member

AThousandShips commented Nov 21, 2024

This shouldn't be relevant any longer as this was solved in past PRs like:

Edit: Indeed the associated issue was closed as solved, so closing this

Thank you for your contribution nonetheless!

@AThousandShips AThousandShips removed this from the 4.x milestone Nov 21, 2024
@AThousandShips AThousandShips added archived and removed cherrypick:3.x Considered for cherry-picking into a future 3.x release labels Nov 21, 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 this pull request may close these issues.

Doc items breaking into groups by first sentence rather than alphabetically
8 participants