updated docstrings for BGA packages, needs vetting #231
Conversation
This file contains 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
callendorph
reviewed
Jan 8, 2025
src/landpatterns/BGA/planner.stanza
Outdated
| This defines the shape and parameters for the copper, | ||
| soldermask opening, paste application, etc. | ||
| <DOC> | ||
| pad-config:PadConfig with: | ||
| default => DEF-PAD-CONFIG | ||
|
|
||
| ; GridPlanner Base | ||
| doc: \<DOC> | ||
| @title pose | ||
| @desc Pose of the landpattern (default is loc(0.0, 0.0)) |
There was a problem hiding this comment.
This is the one place where this is interesting and adds value. The default argument for both defstruct fields and function arguments is not an easy thing for us to extract from the definitions database. This might be very useful for extracting the default values into the comments and keeping them up to date.
|
@callendorph Check out this version. |
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.
No description provided.