docs(surfinfo): add missing docstring for flat_border - #694
Merged
anujanegi merged 2 commits intoSep 21, 2026
Merged
Conversation
flat_border had no docstring at all despite being on the website's API reference. Describes its outfile/subject parameters and the lines/ismwalls arrays it saves. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
flat_border references an undefined `height` variable, which raises NameError as written. Adds a FIXME comment noting this and pointing to the commented-out Image.new(...) call that suggests it was meant to be a parameter, for a reviewer to decide the right fix. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
AgarwalNilay
force-pushed
the
docs/surfinfo-docstrings
branch
from
August 24, 2026 16:37
010f43a to
6c02855
Compare
anujanegi
approved these changes
Sep 21, 2026
Collaborator
There was a problem hiding this comment.
LGTM. Verified the new docstring against the implementation line-by-line:
linesentries arepts[pbnd, :2]— 2D point arrays, matches the description.ismwallsentries are thepmwbooleans — matches.- Style/format is consistent with the other docstrings in this file (
curvature,distortion,thickness,tissots_indicatrix): same Parameters layout, no Returns section (correct, since these functions only write tooutfile).
Also checked the FIXME comment about the undefined height name: flat_border has no callers or tests anywhere in the codebase, and there's no existing tracking issue for it, so this is dead/broken legacy code. Documenting the landmine rather than guessing at a fix is the right call for a docs-scoped PR — no behavior change, low risk.
CI is green across the board. Approving.
Reviewed with Claude Code assistance.
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
4 participants
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.
flat_border had no docstring at all despite being on the website's API reference. Describes its outfile/subject parameters and the lines/ismwalls arrays it saves.