Repository navigation

Docstring diet: private code keeps prose, not sections; one-line properties - #766

Merged

jtravs merged 57 commits into

mainfrom

chore/docstring-diet

Nov 12, 2026

Merged

Docstring diet: private code keeps prose, not sections; one-line properties#766
jtravs merged 57 commits into
mainfrom
chore/docstring-diet

Commits on Nov 12, 2026
- Add tools/docstring_diet.py to slim private docstrings
  
  jtravs
  and
  claude
  committed
  87ec67a
- Slim private docstrings in solprop.stepper
  
  jtravs
  and
  claude
  committed
  3c91766
- Slim private docstrings in solprop.calibration
  
  jtravs
  and
  claude
  committed
  194950a
- Shorten _accurate's docstring by hand, as the slimming left it
  
  jtravs
  and
  claude
  committed
  84c4915
- Slim private docstrings in solprop.modes
  
  jtravs
  and
  claude
  committed
  afcc2d7
- Slim private docstrings in solprop.translate
  
  jtravs
  and
  claude
  committed
  476697c
- Slim private docstrings in solprop.driver
  
  jtravs
  and
  claude
  committed
  ffbfe0c
- Shorten two driver summaries by hand, as the slimming left them
  
  jtravs
  and
  claude
  committed
  a077ef5
- Slim private docstrings in solprop's top-level modules
  
  jtravs
  and
  claude
  committed
  03f6ad9
- Restore conventions, refusals and reasons in solprop's top-level private docs
  
  jtravs
  and
  claude
  committed
  de55c23
- Slim private docstrings in solprop.processing
  
  jtravs
  and
  claude
  committed
  5621d75
- Restore conventions, ranges and refusal reasons in solprop.modes private docs
  
  jtravs
  and
  claude
  committed
  58ba563
- Slim private docstrings in solprop.coupling
  
  jtravs
  and
  claude
  committed
  011f287
- Restore the zero-frequency limit rule in solprop.processing private docs
  
  jtravs
  and
  claude
  committed
  485295f
- Restore resume, retention and unit notes in solprop.driver private docs
  
  jtravs
  and
  claude
  committed
  ce0574c
- Slim private docstrings in solprop.plotting
  
  jtravs
  and
  claude
  committed
  9b30ab1
- Slim private docstrings in solprop.output
  
  jtravs
  and
  claude
  committed
  ed8c44e
- Restore a layout note, a platform note and a hash reason in solprop.output private docs
  
  jtravs
  and
  claude
  committed
  096af3a
- Slim private docstrings in solprop.service
  
  jtravs
  and
  claude
  committed
  615b3a5
- Restore flags, conventions and reasons in solprop.coupling private docs
  
  jtravs
  and
  claude
  committed
  eb340ba
- Restore why the scan reader is picklable in solprop.service private docs
  
  jtravs
  and
  claude
  committed
  8fb0ae5
- Slim private docstrings in solprop.nonlinear
  
  jtravs
  and
  claude
  committed
  873f602
- Slim private docstrings in solprop.recipe
  
  jtravs
  and
  claude
  committed
  cf2bf9e
- Shorten _length_fraction's summary and rename solve_pin's closure by hand
  
  jtravs
  and
  claude
  committed
  7790961
- Restore conventions and reasons in solprop.translate private docs
  
  jtravs
  and
  claude
  committed
  cea21d0
- Slim private docstrings in solprop.backends
  
  jtravs
  and
  claude
  committed
  1a40933
- Restore flags, conventions and warnings in solprop.nonlinear private docs
  
  jtravs
  and
  claude
  committed
  2f46f19
- Slim private docstrings in solprop.physdata
  
  jtravs
  and
  claude
  committed
  84d7228
- Test engineering's None and NaN text, which a dropped doctest covered
  
  jtravs
  and
  claude
  committed
  a1d62cc
- Restore warning policies and conventions in solprop.physdata private docs
  
  jtravs
  and
  claude
  committed
  09964fd
- Slim private docstrings in solprop_native
  
  jtravs
  and
  claude
  committed
  9ec0de3
- Restore flags, layouts and policies in solprop_native private docs
  
  jtravs
  and
  claude
  committed
  4f79d9c
- Restore conventions and reasons in solprop.backends private docs
  
  jtravs
  and
  claude
  committed
  615c1fa
- Keep the dropped private doctests' checks as unit tests
  
  jtravs
  and
  claude
  committed
  10a8076
- Merge the top-level, processing and plotting docstring slimming
  
  jtravs
  and
  claude
  committed
  986c489
- Merge the translate and backends docstring slimming
  
  jtravs
  and
  claude
  committed
  f8c565c
- Capitalise Stokes and Cartesian in two slimmed docstrings
  
  jtravs
  and
  claude
  committed
  189bdae
- Merge the driver, output, service and recipe docstring slimming
  
  jtravs
  and
  claude
  committed
  49455d6
- Restore Taylor's capital in three solprop.driver bullets
  
  jtravs
  and
  claude
  committed
  67e0332
- Merge the driver capitalisation fix
  
  jtravs
  and
  claude
  committed
  9a7e359
- Restore capitals the slimming lowered in group C bullets
  
  jtravs
  and
  claude
  committed
  7acf8f3
- Merge the modes, coupling, nonlinear, physdata and native docstring slimming
  
  jtravs
  and
  claude
  committed
  768078c
- Give public properties one-line summaries, no Returns sections
  
  jtravs
  and
  claude
  committed
  9f3b6f8
- Fold units into property summaries and drop restated returns
  
  jtravs
  and
  claude
  committed
  f6c6c39
- Tighten the size ratchets to the slimmed docstrings
  
  jtravs
  and
  claude
  committed
  12ce9d9
- Remove the docstring diet tool; the size ratchet holds the rule
  
  jtravs
  and
  claude
  committed
  4d6c7f1
- Narrow two new tests' types for basedpyright
  
  jtravs
  and
  claude
  committed
  32a5e28
- Merge the lean-rules review fixes
  jtravs
  committed
  efd194a
- Merge main (frozen copies, lean rules) into the docstring diet
  jtravs
  committed
  3756084
- Drop docstring bullets that only restate the annotation
  
  jtravs
  and
  claude
  committed
  23eb149
- Give the native public properties the one-line property docstring
  
  jtravs
  and
  claude
  committed
  c03684d
- Give the Protocol property stubs noun-phrase summaries
  
  jtravs
  and
  claude
  committed
  89ff772
- Name the effective-area path's unit once
  
  jtravs
  and
  claude
  committed
  4e90a96
- Test the even chunk and the display tail the diet's examples showed
  
  jtravs
  and
  claude
  committed
  2333c64
- Keep the name of the closure gnlse_source returns
  
  jtravs
  and
  claude
  committed
  e1c4ba4
- Say when a nested function takes a leading underscore
  
  jtravs
  and
  claude
  committed
  f258410
- Start four property summaries with "The" so numpydoc reads no verb
  
  jtravs
  and
  claude
  committed
  a2a7b7b

Commits

Commits on Nov 12, 2026