mirror of
https://github.com/xcat2/xcat-core.git
synced 2026-09-05 12:37:54 +00:00
Daniel Hilst
dfdc4f4293
The module is seven short subs over a hash of counters, and nothing in it says what is being paced or why the pacing is shaped this way. A reader can follow every line and still not know that the delay ceilings rather than terminates, that `healthy` means "stayed up long enough to have claimed its resource", or that returning a new state instead of mutating one is load-bearing rather than stylistic. Add a short header giving the module's intent -- what it paces, why it backs off, why it never stops, and why the functions are pure -- and one line per sub in (inputs) -> output form. Not the banner from docs/source/developers/guides/code/code_standard.rst: every one of these takes a state and a timestamp, so seven Arguments:/Returns: blocks would restate the same signature and bury the line that carries meaning. Signed-off-by: Daniel Hilst <392820+dhilst@users.noreply.github.com>
xCAT is a toolkit for the deployment and administration of clusters. xCAT documentation is available at: http://xcat-docs.readthedocs.org/ xCAT is made available as open source software under the EPL license: http://www.opensource.org/licenses/eclipse-1.0.php