search

pulibrary / dspace-cli

command line scripts accessing and modifying DSpace content
0 stars 0 forks source link

Improving the documentation for the DCollection, DCommunity, DBitstream, DItem, and DMetadataField Classes, as well as the DSpace Module #20

Closed jrgriffiniii closed 4 years ago

jrgriffiniii commented 4 years ago

Builds upon https://github.com/pulibrary/dspace-cli/pull/19 and advances #18

jrgriffiniii commented 4 years ago

This is fairly far along, I'm going to try and extend the scope of this to cover all Classes in the code base. I have some thoughts regarding the documenting of routines, but I will create a new GitHub issue in order to discuss these.

jrgriffiniii commented 4 years ago

This completes all documentation for classes and methods declared in this project (please see https://inch-ci.org/github/pulibrary/dspace-cli?branch=yard-cli-dir&pending_build=578469).

However, as one can observe, there are a number of undocumented routines which are provided by dspace-cli. Given that these are not intended to serve as an API?