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 package types in documentation #4228

Merged
merged 3 commits into from
Nov 7, 2022
Merged

Conversation

mfelsche
Copy link
Contributor

@mfelsche mfelsche commented Nov 4, 2022

Previously they have been unordered, which makes finding them hard, especially for packages with many types (like builtin). This change explicitly does not sort the fields, constructors, methods and behaviours inside a types documentation. Although I would argue that this would also help finding those elements inside a type (e.g. the documentation for chop in Array).

Previously they have been unordered, which makes finding them hard, especially for packages with many types (like builtin).
This change explicitly does not sort the fields, constructors, methods and behaviours inside a types documentation. Although I would argue that this would also help finding those elements inside a type (e.g. the documentation for chop in Array).
@ponylang-main ponylang-main added the discuss during sync Should be discussed during an upcoming sync label Nov 4, 2022
@mfelsche mfelsche added changelog - changed Automatically add "Changed" CHANGELOG entry on merge and removed discuss during sync Should be discussed during an upcoming sync labels Nov 4, 2022
@ponylang-main
Copy link
Contributor

Hi @mfelsche,

The changelog - changed label was added to this pull request; all PRs with a changelog label need to have release notes included as part of the PR. If you haven't added release notes already, please do.

Release notes are added by creating a uniquely named file in the .release-notes directory. We suggest you call the file 4228.md to match the number of this pull request.

The basic format of the release notes (using markdown) should be:

## Title

End user description of changes, why it's important,
problems it solves etc.

If a breaking change, make sure to include 1 or more
examples what code would look like prior to this change
and how to update it to work after this change.

Thanks.

@ponylang-main ponylang-main added the discuss during sync Should be discussed during an upcoming sync label Nov 4, 2022
@chalcolith
Copy link
Member

I am very much in favour of this, as scanning for things in the pony documentation is a constant source of frustration for me.

@SeanTAllen
Copy link
Member

Ah so this is sorting for things that are collected across several files in a package, yes?

@mfelsche
Copy link
Contributor Author

mfelsche commented Nov 5, 2022

Ah so this is sorting for things that are collected across several files in a package, yes?

Correct.

@SeanTAllen
Copy link
Member

@mfelsche one small change. Please make each paragraph in the release notes a not have newlines. This helps with display in various mediums so that we don't have weird "early" cut offs or "cut-offs that are too late".

Once that is done, I think this is fine to merge.

@SeanTAllen SeanTAllen merged commit 32553fc into main Nov 7, 2022
@SeanTAllen SeanTAllen deleted the docgen-sort-package-items branch November 7, 2022 20:14
@ponylang-main ponylang-main removed the discuss during sync Should be discussed during an upcoming sync label Nov 7, 2022
github-actions bot pushed a commit that referenced this pull request Nov 7, 2022
github-actions bot pushed a commit that referenced this pull request Nov 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog - changed Automatically add "Changed" CHANGELOG entry on merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants