[darcs-devel] [patch1867] improve doc comments for Rotcilfnoc

[Ganesh Sittampalam]

New submission from Ganesh Sittampalam <ganesh at earth.li>:

For discussion for now.

I'm not sure if this is an improvement or not, but I found
the existing comments "inverted [effect,conflict,identity] a
bit confusing. So I reworded it according to my
understanding to see if that also makes sense to others.

Whilst "inverted effect" is accurate in that
it is the inverse of the effect of the Rotcilfnoc, and
perhaps the identity can also be seen as being inverted,
relative to the identity of the Rotcilfnoc, I don't think
it really makes sense to talk about the Rotcilfnoc conflicting
with the inverse of the conflicting patches.

I did also have a quick play with abstracting out the triple
(effect, conflicts, identity) into a separate type to reduce
the duplication, but I don't think it really helps with code
reuse or factoring and it just makes things more verbose.

1 patch for repository darcs-unstable at darcs.net:screened:

patch 1fe95add7d2b4ba171abafac14fe4bc89232723c
Author: Ganesh Sittampalam <ganesh at earth.li>
Date:   Sun Aug 11 17:52:58 BST 2019
  * improve doc comments for Rotcilfnoc

----------
files: improve-doc-comments-for-rotcilfnoc.dpatch, patch-preview.txt, unnamed
messages: 21081
nosy: ganesh
status: needs-screening
title: improve doc comments for Rotcilfnoc

__________________________________
Darcs bug tracker <bugs at darcs.net>
<http://bugs.darcs.net/patch1867>
__________________________________
-------------- next part --------------
A non-text attachment was scrubbed...
Name: patch-preview.txt
Type: text/x-darcs-patch
Size: 843 bytes
Desc: not available
URL: <http://lists.osuosl.org/pipermail/darcs-devel/attachments/20190812/fe09962c/attachment-0002.bin>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: improve-doc-comments-for-rotcilfnoc.dpatch
Type: application/x-darcs-patch
Size: 33161 bytes
Desc: not available
URL: <http://lists.osuosl.org/pipermail/darcs-devel/attachments/20190812/fe09962c/attachment-0003.bin>
-------------- next part --------------
.