Doc fixes 2#422
Conversation
james-d-mitchell
force-pushed
the
doc-fixes-2
branch
from
d0f27a9 to
ce681f3
Compare
Joseph-Edwards
left a comment
Joseph-Edwards
left a comment
There was a problem hiding this comment.
I think the changes in this PR are good. I noticed there were a few things that had been corrected in some files but not others (e.g. all return sentences begin with a capital letter, but param sentences do not) so I've added a few more commits to catch a few more. I have one question below, but otherwise I'm happy to merge, provided you're happy with my new changes @james-d-mitchell?
| classes. | ||
|
|
||
| :param kb1: the instance to compute the partition. | ||
| :param kb1: the instance to compute the partition with. |
There was a problem hiding this comment.
I'm not sure if "with" is the right word here, but I don't have any other suggestions I'm convinced are better. "the instance used to compute the partition of *kb2*"?
There was a problem hiding this comment.
I see where you're coming from, but I think adding "with" here is a good change (or possibly neutral). I think of this in the following way: both kb1 and kb2 represent equivalence relations, we are trying to partition the normal forms related to kb2 into their classes in kb1, which could be described as "partitioning the normal forms of kb2 with kb1". Does this sound convincing?
james-d-mitchell
force-pushed
the
doc-fixes-2
branch
from
6ce7b2c to
ffdf50d
Compare
3 participants
This a bunch more doc fixes found (mostly) by Codex disjoint from #420