Skip to content

Document descriptions for doc groups #2132

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

lud
Copy link
Contributor

@lud lud commented Jun 18, 2025

First attempt at the docs. Docs are hard, as always.

I splitted the different concepts (attaching to groups / descriptions / ordering) for clarity, not sure if it is OK.

We may want to fix default ordering (displaying groups from :default_group_for_doc before Types,Functions,Callbacks) and update the docs before merging this.

Copy link

@josevalim
Copy link
Member

We may want to fix default ordering (displaying groups from :default_group_for_doc before Types,Functions,Callbacks) and update the docs before merging this.

Are you planning to send a PR for this too? :) You can also amend this one if you prefer!

%{title: "Helpers", description: "Functions shared with other modules."}
]
Descriptions can be given in the `:default_group_for_doc` configuration:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Descriptions can be given in the `:default_group_for_doc` configuration:
Descriptions can also be given in the `:default_group_for_doc` configuration:

@lud
Copy link
Contributor Author

lud commented Jun 18, 2025

Are you planning to send a PR for this too? :) You can also amend this one if you prefer!

If we have to fix it then yes I'll update this PR.

@josevalim
Copy link
Member

Yes, I should probably preserve it to avoid breaking changes, unless it would add a lot of complexity or complications. I am hoping it is rather just swapping operands somewhere :D

@lud
Copy link
Contributor Author

lud commented Jun 18, 2025

Yeah ok, it should not be that hard.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants