search

yanne / api-test

0 stars 0 forks source link

Add missing and proofread existing docs of the programmatic public API #92

Closed yanne closed 10 years ago

yanne commented 10 years ago

AbstractSSHClient defines the public API of the library that can be used also programmatically. Such an API obviously needs documentation, and there are two tasks related to it:

1) Add docs for the new methods such as get_directory. Basically all public methods ought to have some kind of a doc. These docs don't need to be as detailed as the related keyword docs, though.

2) Proofread the existing docs. They seem to have some typos, and not all methods document what they return. Notice also that return values of get/put methods are likely to change.

This issue was originally opened at Google Code on Oct 24, 2013.

yanne commented 10 years ago

Original comment by anssi.sy...@eficode.com on Nov 26, 2013.

This issue was updated by revision f96b34139f00 .

Added documentation for the methods in AbstractClient.

yanne commented 10 years ago

Original comment by anssi.sy...@eficode.com on Nov 26, 2013.

This issue was updated by revision c0796191a93c .

Added documentation for the rest of the non-internal methods and methods raising NotImplementedError in AbstractClient.

Also did some minor refactoring regarding the method/variable names.

yanne commented 10 years ago

Original comment by anssi.sy...@eficode.com on Nov 26, 2013.

This issue was updated by revision c8109559cd11 .

Went through the methods once more and improved the documentation slightly here and there.