Repository navigation
Generated docstring format + install from GitHub URL - #5
Merged
Merged
Conversation
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
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.
Two minor changes:
1. Generated-source docstring: triple quotes on their own lines
The embedded original source now renders in conventional docstring style — opening quotes, outer-level source lines, and the closing quotes all at function-body indent, inner lines keeping their relative indentation:
ast.get_docstring/inspect.getdocon the generated function recover the original scalar source verbatim (added as a regression test).docs/index.mdupdated to match.2. Installation instructions use the GitHub repo URL
README and
docs/index.mdnow install viapip install "array-vectorize @ git+https://github.com/grAItools/array-vectorize.git"instead of assuming a local checkout (dev-from-checkout kept as a secondary note; PyPI note added).Verification
make check(711 passed, coverage 96%),make docsstrict — all green. Formatter considered and rejected for generated source:ast.unparseoutput stays the single deterministic renderer (no runtime formatting dependency).