PyUtilib / pyutilib

A collection of general Python utilities, including logging and file IO, subprocess management, plugin systems, and workflow management.
BSD 3-Clause "New" or "Revised" License
34 stars 20 forks source link

Updates to pyutilib.misc.config #88

Closed jsiirola closed 4 years ago

jsiirola commented 4 years ago

Fixes: #N/A

Summary/Motivation:

This PR adds some long-overdue documentation for the ConfigValue / ConfigList / ConfigDict system. As part of this, it resolved some bugs and begins the process to rename ConfigBlock to ConfigDict (both names are currently supported). The documentation was confirmed to build and pass doctests (using the Pyomo Online Docs harness).

Changes proposed in this PR:

Legal Acknowledgement

By contributing to this software project, I agree to the following terms and conditions for my contribution:

  1. I agree my contributions are submitted under the BSD license.
  2. I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.
coveralls commented 4 years ago

Coverage Status

Coverage decreased (-0.08%) to 60.993% when pulling f129c2e22742e5c4501b13e9cda093fdd70b062b on jsiirola:config-updates into 0fd5f242a0df2138975aa45029a81cbb3b5db8b2 on PyUtilib:master.

codecov-io commented 4 years ago

Codecov Report

Merging #88 into master will decrease coverage by 0.09%. The diff coverage is 66.66%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #88      +/-   ##
==========================================
- Coverage   63.10%   63.00%   -0.10%     
==========================================
  Files          87       87              
  Lines        8800     8824      +24     
==========================================
+ Hits         5553     5560       +7     
- Misses       3247     3264      +17     
Impacted Files Coverage Δ
pyutilib/misc/config.py 92.51% <66.66%> (-2.23%) :arrow_down:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 0fd5f24...f129c2e. Read the comment docs.