Improve code documentation, second batch #106
Conversation
| //! - *Values*: merging any other values succeeds if and only if these two values are equals, in which case it evaluates to | ||
| //! this common value. | ||
| //! | ||
| //! Note that merging of lists is not yet implemented. |
There was a problem hiding this comment.
I suppose that, on list, merging ought to be “the lists have the same size, and we recursively merge corresponding elements”. Or maybe not, I don't know. Is there a design issue?
There was a problem hiding this comment.
Not really, it's just that lists were added after merging and this particular point has not been discussed. I think we can either not give it a special treatment (only merge identical lists), and rely on a future support for user-defined merge to do something different, or implement directly your suggestion.
| //! - *Default/default*: merging two terms with default (either `Default` or `ContractDefault`) fails, as there cannot | ||
| //! be two default values for the same field |
There was a problem hiding this comment.
Shouldn't it be the merge of both default values, really?
There was a problem hiding this comment.
Yes, probably. Let me make an issue and fix it in another PR.
yannham
force-pushed
the
doc/improve-code-doc-2
branch
from
b43108f
to
19b0a39
Compare
Follow-up of #105.