User documentation for DuplicateRecordFields
ClosedPublic

Authored by adamgundry on Nov 24 2015, 4:30 AM.

Details

Summary

This is a first draft of the user manual documentation for
DuplicateRecordFields. Feedback welcome. I've intentionally made this
a minimal change, but I wonder if it might make sense to pull out all
the subsections on record system extensions ("Traditional record syntax",
and "Record field disambiguation" through to "Record wildcards") into
a new section? That is, is it worth breaking down the rather monolithic
"Syntactic extensions" section?

Test Plan

n/a

Diff Detail

Repository
rGHC Glasgow Haskell Compiler
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
adamgundry updated this revision to Diff 5294.Nov 24 2015, 4:30 AM
adamgundry retitled this revision from to User documentation for DuplicateRecordFields.
adamgundry updated this object.
adamgundry edited the test plan for this revision. (Show Details)
adamgundry added reviewers: austin, bgamari, simonpj.
bgamari edited edge metadata.Nov 24 2015, 4:46 AM

That is, is it worth breaking down the rather monolithic "Syntactic extensions" section?

An emphatic "yes" from me! It's quite difficult to find the particular extension you are looking for under the current organization.

I've wanted to break up the glasgow_exts source file for a long time as well.

simonpj edited edge metadata.Nov 24 2015, 4:56 AM

Arguably, all the sections about records (namely: record field disambiguation, puns, wildards), plus the new stuff, would be better under the next section "Extensions to data types and synonyms". Or even (like "deriving") a new sub-section of Section 7.

I'd be ok with splitting up glasgow_exts too if you want

adamgundry updated this revision to Diff 5295.Nov 24 2015, 5:10 AM
adamgundry edited edge metadata.

Pull out record extensions docs as a new section

For reviewing the new docs, it's probably best if you look at the
previous revision of the diff. This doesn't change the text, just
moves lots of things around.

bgamari accepted this revision.Nov 24 2015, 7:55 AM
bgamari edited edge metadata.

Thanks Adam!

This revision is now accepted and ready to land.Nov 24 2015, 7:55 AM
austin accepted this revision.Nov 24 2015, 9:49 AM
austin edited edge metadata.

LGTM

Also, big +1 on doc refactoring.

This revision was automatically updated to reflect the committed changes.