Join GitHub today
Re-organise exception types documentation #516
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 :)