Condense docstrings to their load-bearing content#47
Merged
Conversation
Trim docstrings whose elaboration restated the summary line, duplicated documentation living elsewhere, or used Args scaffolding: the Memory class, BenchmarkReport, HuggingfaceSource, MinimallocSource, BaseSource (drops the registry-key note covered by Registered), Registered, run_benchmark and plot_allocation (Args blocks become prose preserving every parameter form), and save_allocation. In analysis, the per-allocation pressure variants now defer to their aggregate counterparts for the shared theory instead of restating it, keeping only their own contracts (pinned antichains, budget behavior, bound relationships); conflict_degrees likewise leans on conflicts while keeping its positional/duplicate-id semantics. Reflow wraps left ragged by the antichain_pressure rename.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Trim docstrings whose elaboration restated the summary line, duplicated
documentation living elsewhere, or used Args scaffolding: the Memory
class, BenchmarkReport, HuggingfaceSource, MinimallocSource, BaseSource
(drops the registry-key note covered by Registered), Registered,
run_benchmark and plot_allocation (Args blocks become prose preserving
every parameter form), and save_allocation.
In analysis, the per-allocation pressure variants now defer to their
aggregate counterparts for the shared theory instead of restating it,
keeping only their own contracts (pinned antichains, budget behavior,
bound relationships); conflict_degrees likewise leans on conflicts while
keeping its positional/duplicate-id semantics. Reflow wraps left ragged
by the antichain_pressure rename.