darcs

Patch 1171 Documentation for Darcs.Patch.Witnesses.... (and 2 more)

Title Documentation for Darcs.Patch.Witnesses.... (and 2 more)
Superseder Nosy List alex.aegf
Related Issues
Status accepted Assigned To
Milestone

Created on 2014-06-10.02:47:48 by alex.aegf, last changed 2014-06-12.17:17:10 by gh.

Files
File name Status Uploaded Type Edit Remove
documentation-for-darcs_patch_witnesses_ordered-module_.dpatch alex.aegf, 2014-06-10.02:47:48 application/x-darcs-patch
documentation-for-darcs_patch_witnesses_ordered-module_.dpatch alex.aegf, 2014-06-10.19:08:29 application/x-darcs-patch
documentation-of-function-darcs_repository_internal_misplacedpatches-_.dpatch alex.aegf, 2014-06-11.05:57:07 application/x-darcs-patch
patch-preview.txt alex.aegf, 2014-06-10.02:47:47 text/x-darcs-patch
patch-preview.txt alex.aegf, 2014-06-10.19:08:29 text/x-darcs-patch
patch-preview.txt alex.aegf, 2014-06-11.05:57:07 text/x-darcs-patch
unnamed alex.aegf, 2014-06-10.02:47:48
unnamed alex.aegf, 2014-06-10.19:08:29
unnamed alex.aegf, 2014-06-11.05:57:07
See mailing list archives for discussion on individual patches.
Messages
msg17534 (view) Author: alex.aegf Date: 2014-06-10.02:47:48
Following with the task of documenting. I still have to some doubt for the function chooseOrder.

Cheers.

3 patches for repository http://darcs.net:

Mon Jun  9 17:20:12 ART 2014  Ale Gadea <alex.aegf@gmail.com>
  * Documentation for Darcs.Patch.Witnesses.Ordered module.

Mon Jun  9 18:25:04 ART 2014  Ale Gadea <alex.aegf@gmail.com>
  * Documentation for Darcs.Patch.Witnesses.Sealed module.

Mon Jun  9 23:39:49 ART 2014  Ale Gadea <alex.aegf@gmail.com>
  * Documentation of function Darcs.Patch.Witnesses.Sealed.chooseOrder .
Attachments
msg17535 (view) Author: gh Date: 2014-06-10.17:58:03
Good, here are a few improvements you can do:



# Darcs.Patch.Witnesses.Ordered

* "Not Haddock" -> "non-haddock"
* "the symmetry of merge" -> "the symmetry of merge types"
* you can remove the 'intentory' hunk from this patch

#  Darcs.Patch.Witnesses.Sealed

* "the same has" -> "the same as"
* you can remvoe the hunk "-- (Not exported)"

# Darcs.Patch.Witnesses.Sealed.chooseOrder 

* this function is part of Darcs.Repository.Internals, so change the
patch name
* the first hunk is obsolete if you update the 1st patch ofthe bundle
msg17536 (view) Author: alex.aegf Date: 2014-06-10.19:08:29
3 patches for repository http://darcs.net:

Tue Jun 10 15:52:40 ART 2014  Ale Gadea <alex.aegf@gmail.com>
  * Documentation for Darcs.Patch.Witnesses.Ordered module.

Tue Jun 10 16:00:35 ART 2014  Ale Gadea <alex.aegf@gmail.com>
  * Documentation for Darcs.Patch.Witnesses.Sealed module.

Tue Jun 10 16:01:42 ART 2014  Ale Gadea <alex.aegf@gmail.com>
  * Documentation of function Darcs.Repository.Internal.chooseOrder .
Attachments
msg17537 (view) Author: gh Date: 2014-06-10.20:31:47
I've accepted the first two patches.

As for the third, I believe changing the name "chooseOrder" to
"misplacedPatches" will do it, and replacing the "Breaks up the
inventory" comment to something like:

"-- | Returns the patches that make the most recent tag dirty."
msg17539 (view) Author: alex.aegf Date: 2014-06-11.05:57:07
1 patch for repository http://darcs.net:

Wed Jun 11 02:47:43 ART 2014  Ale Gadea <alex.aegf@gmail.com>
  * Documentation of function Darcs.Repository.Internal.misplacedPatches .
  misplacedPatches is the new name of the function called chooseOrder.
Attachments
msg17541 (view) Author: gh Date: 2014-06-12.17:17:10
Good, accepted.
History
Date User Action Args
2014-06-10 02:47:48alex.aegfcreate
2014-06-10 17:58:03ghsetmessages: + msg17535
2014-06-10 19:08:29alex.aegfsetfiles: + patch-preview.txt, documentation-for-darcs_patch_witnesses_ordered-module_.dpatch, unnamed
messages: + msg17536
2014-06-10 20:31:47ghsetstatus: needs-screening -> accepted-pending-tests
messages: + msg17537
2014-06-11 05:57:08alex.aegfsetfiles: + patch-preview.txt, documentation-of-function-darcs_repository_internal_misplacedpatches-_.dpatch, unnamed
messages: + msg17539
2014-06-12 17:17:10ghsetstatus: accepted-pending-tests -> accepted
messages: + msg17541