-
-
Notifications
You must be signed in to change notification settings - Fork 419
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
Conversation
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).
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 The basic format of the release notes (using markdown) should be:
Thanks. |
I am very much in favour of this, as scanning for things in the pony documentation is a constant source of frustration for me. |
Ah so this is sorting for things that are collected across several files in a package, yes? |
Correct. |
@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. |
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).