[Tracking] Documenting Base
Thank you for your interest in documenting the Haskell standard library, aka.
This is the tracking issue for documenting
This issue is intended to be linked in each MR that would improve the documentation situation in
base modules, and will list
some modules for which lack of documentation is deemed a priority task.
You are encouraged to tackle a module if you think you can add something missing, be it examples, unmentioned edge-case, or
a direct risk of runtime error (through the use of
Building the docs
In order to build the
base haddocks, please follow the first three steps listed at ghc.dev, and then run
$ hadrian/build -j --freeze1 --flavour=Quick _build/docs/html/libraries/base/base.haddock
You will then find the index file at
If you wish to discuss this effort or ask for advice, let's have a chat at #haskell-docs on Freenode.
You should also subscribe to the
which will warn you if GitLab is going under maintenance.
Finally, as we are operating in the context of the GHC project, you will be required to abide by its guidelines for respectful communication. Disagreement fosters debate, but in no way the Haskell Documentation initiative should be used to deny someone's humanity or basic human rights.
If you wish to express some concerns about how you are treated in the Haskell discussion and work spaces, you can contact the co-chairs of the GHC Steering Committee, Simon Marlow and Simon Peyton-Jones.
Thank you for joining us. :)
Merge Requests Etiquette
When creating a merge request:
- Insert the following snippet of text at the end of the description:
- Mention @core-libraries (by simply writing it out) at the end of the description. This will greatly help the process;
- Insert the
~documentationlabel. You can use the quick action
/label ~documentationat the end of the MR's description;
- Set the milestone to
- Include a screenshot of the rendered HTML documentation.
Moreover, when inserting examples, please use the collapsible headers syntax. This will greatly help readability!
These modules require some special attention, either due to the state of their documentation, their importance for newcomers to the language, or both:
PS: The linked documentation points to
base 188.8.131.52, that is to be shipped with GHC 8.10.1-rc1
- 2020-03-19: Bugfix in Haddock to show module-level collapsible sections & examples
- 2020-03-28: Fix crash in
haddock-libraryon unicode space