On Mon, Nov 04, 2019 at 01:21:22PM -0800, Sean Christopherson wrote: > On Mon, Nov 04, 2019 at 10:01:41PM +0200, Jarkko Sakkinen wrote: > > The subordinate clause of last sentence of the sgx_ioc_enclave_pages() > > does not provide any insight not already provided. Thus, remove it. > > Isn't the whole point of the documentation to help the user understand > *how* to use the API, not simply state exactly what the code does? For kdoc it should explain in clear and concise way That clause does not provide any help for that. It just repeats with different vocabulary the exact same thing as was already said. > > Also, using "i.e." (and "e.g.") in the documentation should be > > considered a bad practice because it leaves it open ended. > > How does stating the practical effect of the semantics leave the docs open > ended? The man pages for open[1], close[2], read[3], dlopen[4], etc... > all provide examples (usually with "for example" verbiage) to call out > common scenarios to help the reader understand the details, and close() > also uses "i.e." to clarify. I did not find the use of "i.e." or "e.g." from those. When they introduce an example it is done in a more structured way, not as a subordinate clause. /Jarkko
