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

Re-organise exception types documentation #516

Open
jonathanstowe opened this Issue May 15, 2016 · 1 comment

Comments

Projects
None yet
3 participants
@jonathanstowe
Contributor

jonathanstowe commented May 15, 2016

There are a lot of Exception classes (somewhere over 250 defined in the Exception.pm,) If they were all to be documented (and the assumption would be that they should be,) they would swamp the types documentation page and become rather un-manageable.

They should be searchable and linkable from , for example, the places where they are thrown, but otherwise the individual exceptions are not particularly interesting unless you actually have one in hand and want to know what it is all about.

I'd like to suggest that they might be put into some sub-category of "type" such that they are all listed on a separate page, which could, for example, be linked to the main type page by "X" (which would itself address the suggestion made by @dha that 'X' should be documented somehow.

I guess that this would require some changes to both p6doc and to the tooling that generates the web pages as well as (probably automatable) changes to the existing documentation (to the links to the existing X::* class documentation.)

This however shouldn't be a barrier in the first instance to documenting the remaining exceptions :)

@JJ

This comment has been minimized.

Contributor

JJ commented Mar 13, 2018

Related #1829 #1813

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