AssertionError is not documented

[targos]

AssertionError is exported by the assert module.
The documentation has many mentions to AssertionError but the value itself is not documented. I think it deserves a paragraph.

[joyeecheung]

Labeled as a good first contribution for now. We can remove it later if nobody opens a PR for it.

[shubheksha]

Hey, I can help with this if given some pointers about what regarding AssertionError needs to be included. 😄

[addaleax]

@shubheksha It should probably include AssertionError as a new heading, mention since when it is exported (let me know/ping me on IRC if you are not sure how to figure that out), and mention/explain its own properties (actual, expected, operator, and maybe generatedMessage).

[shubheksha]

@addaleax, thanks for the info! Will it go as a heading in assert.md at the very top?

[addaleax]

@shubheksha Either that, or at the very bottom (and as a ## heading, under the big # Assert one, in any case). The headings should be sorted alphabetically, but I’m not sure myself how to interpret that here. 😄

[joyeecheung]

@shubheksha Or you can put it in errors.md and link to it from assert.md. The other way around works fine too, but I think the examples in errors.md would help you know what needs to be included :D

[addaleax]

ping @shubheksha … is there anything we can help with? :)