Closed sajith closed 2 months ago
Files with Coverage Reduction | New Missed Lines | % | ||
---|---|---|---|---|
fabrictestbed_extensions/fablib/node.py | 6 | 7.84% | ||
<!-- | Total: | 6 | --> |
Totals | |
---|---|
Change from base Build 9646708720: | 0.01% |
Covered Lines: | 1166 |
Relevant Lines: | 4704 |
I made a table of fabrictestbed.fablib.node.Node
methods that do not have a docstring. I strongly suspect that many of them could be (or should be) private.
delete()
is the one that did not have a docstring.set_user_data()
and get_user_data()
in notebook examples. If these are meant to be public, they deserve better documentation.The ticked boxes mean that I've tried to add something (mostly a warning) to the method next to it in this PR.
method | comment | should be made private? |
---|---|---|
|
Called internally many times | maybe? |
|
Called by show() |
maybe? |
|
What is this used for? | |
|
Called by render_template() |
maybe? |
|
Called by get_ssh_command() andrun_post_boot_tasks() |
maybe? |
|
Called by list_networks() |
maybe? |
|
Called by execute() ,upload_file() ,and download_file() |
yes |
|
Shortcut to get_fim_node() .Do we need both? |
yes |
|
No examples in notebooks | |
|
No examples in notebooks | |
|
Added rudimentary docstring | |
|
Called by new_node() |
yes |
|
Called internally many times | yes |
|
Called internally many times | yes |
|
Called by config_routes() which iscalled by config() |
no? |
|
See above. | maybe? |
|
Called by config() |
maybe? |
|
Called by config() |
maybe? |
|
Called by config() |
maybe? |
|
Called by config() |
maybe? |
|
Called by config() |
maybe? |
|
What is this used for? No usage in notebooks. |
Addresses #318. Adds some docstrings to
fablib.node.Node
methods.I'm not familiar with the usage of
Node.generate_template_context()
,Node.get_template_context()
, andNode.render_template()
, so leaving that out for a later round.Also re-formats docstrings in
fablib
andslice
modules so thattox -e docs
will work. Toxdocs
environment is set up to treat warnings as errors.