ENH/DOC: docstrings + start of API docs #89
Merged
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.
(This is part of a larger branch which got to be unmanageably large - breaking it up into separate PRs. This is the largest of them!)
blark.transform
dataclassesCodeSummary.from_parse_results
can now take just a single parse result, for convenienceblark.summary
and (non-smoke!) test coveragecode[start:end]
is where this single/multi-line comment came from). This is actually important for ENH: first pass at html output #88 again but is more effort to separate than I want to bother with.API doc example
For
S=
, we haveblark.transform.SetStatement
. This renders in sphinx as:TODO
Documentation won't be "done" once the above is complete and this is merged, for what it's worth. blark is a work-in-progress and this is just the start of this specific effort.