Pierre-Yves David <pierre-yves.david@octobus.net> [Wed, 06 Mar 2019 12:39:44 +0100] rev 41876
verify: document the `_verifymanifest` method
Pierre-Yves David <pierre-yves.david@octobus.net> [Wed, 06 Mar 2019 12:21:58 +0100] rev 41875
verify: document `_verifychangelog`
We document the method input, output and checks.
Pierre-Yves David <pierre-yves.david@octobus.net> [Wed, 06 Mar 2019 14:15:19 +0100] rev 41874
verify: rename the `checklog` to `_checkrevlog`
The method is for internal use only. In addition we make the method name
explicitly contains `revlog` to make it clearer it is checking higher level
revlog properties.
Pierre-Yves David <pierre-yves.david@octobus.net> [Wed, 06 Mar 2019 14:10:23 +0100] rev 41873
verify: document the `checklog` method
Let us add details about what the function is expected to do.
Pierre-Yves David <pierre-yves.david@octobus.net> [Wed, 06 Mar 2019 14:07:27 +0100] rev 41872
revlog: add some documentation to the `checksize` method
I had to look at it, so I figured I would leave some documentation for the next
person seeking information.
Pierre-Yves David <pierre-yves.david@octobus.net> [Wed, 06 Mar 2019 12:20:50 +0100] rev 41871
verify: make `checkentry` a private method
This method is for internal use only.
Pierre-Yves David <pierre-yves.david@octobus.net> [Wed, 06 Mar 2019 12:18:04 +0100] rev 41870
verify: document the `checkentry` method
This method checks various core propertes of a revision. We document inputs, outputs
and the checks performed.
Pierre-Yves David <pierre-yves.david@octobus.net> [Wed, 06 Mar 2019 11:43:21 +0100] rev 41869
verify: add some inline documentation to the top level `verify` method
The goal is to clarify each section goal.
Pierre-Yves David <pierre-yves.david@octobus.net> [Wed, 06 Mar 2019 11:38:54 +0100] rev 41868
verify: explicitly return 0 if no error are encountered
Relying on the fact None is treated as 0 by other logics seems smarter than we
should be.
Pierre-Yves David <pierre-yves.david@octobus.net> [Wed, 06 Mar 2019 11:35:34 +0100] rev 41867
verify: minimal documentation for `verifier.verify`
I expect the docstring to grow over time, so lets start small.