docs: add missing Synopsis/Usage blocks to ball_bearings, shapes3d, metric_screws (#90)#1956
Open
junhinhow wants to merge 3 commits intoBelfrySCAD:masterfrom
Open
docs: add missing Synopsis/Usage blocks to ball_bearings, shapes3d, metric_screws (#90)#1956junhinhow wants to merge 3 commits intoBelfrySCAD:masterfrom
junhinhow wants to merge 3 commits intoBelfrySCAD:masterfrom
Conversation
Both functions had documentation headers but were missing the required Usage sub-block. Added Usage patterns following BOSL2 documentation format, placed after See Also and before Description. Ref: BelfrySCAD#90
Both functions had documentation headers but were missing the Usage sub-block. Added Usage patterns matching the existing xcyl() documentation format for consistency. Ref: BelfrySCAD#90
All public functions and modules in metric_screws.scad had documentation headers but were missing the Synopsis sub-block required by openscad-docsgen. Added Synopsis lines to: - get_metric_bolt_head_size/height() - get_metric_socket_cap_diam/height/socket_size/socket_depth() - get_metric_iso_coarse/fine/superfine_thread_pitch() - get_metric_jis_thread_pitch() - get_metric_nut_size/thickness() - generic_screw() module - metric_nut() module Ref: BelfrySCAD#90
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.
Summary
Usageblocks toycyl()andzcyl()in shapes3d.scad (matching existingxcyl()pattern)Usageblocks toball_bearing()andball_bearing_info()in ball_bearings.scadSynopsisto 14 functions/modules in metric_screws.scadTest plan
Addresses #90
🤖 Generated with Claude Code