Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating documentation for Lindenmayer #31

Merged
merged 23 commits into from
Jan 24, 2022
Merged

Updating documentation for Lindenmayer #31

merged 23 commits into from
Jan 24, 2022

Conversation

heckj
Copy link
Owner

@heckj heckj commented Jan 18, 2022

  • converting to using SwiftUI's Angle type instead of Double in renderers and rendering commands for consistency and usability clarity
  • adding docs to a variety of methods
  • renamed PWrapper to ParameterWrapper
  • normalized rendering commands and removed unimplemented ones

resolves #7

@heckj heckj self-assigned this Jan 18, 2022
@heckj
Copy link
Owner Author

heckj commented Jan 24, 2022

coverage update with this PR:

   --- Experimental coverage output enabled. ---
                | Abstract        | Curated         | Code Listing
Types           | 99% (114/115)   | 100% (115/115)  | 0.87% (1/115)
Members         | 4.4% (431/9733) | 98% (9548/9733) | 0.010% (1/9733)
Globals         | 27% (4/15)      | 100% (15/15)    | 0.0% (0/15)

from command:

xcrun docc convert \
--fallback-display-name Lindenmayer \
--fallback-bundle-identifier Lindenmayer-swift \
--fallback-bundle-version 0.1.0 \
--additional-symbol-graph-dir .build/symbol-graphs \
--experimental-documentation-coverage \
--level brief

@heckj heckj merged commit 1de382c into main Jan 24, 2022
@heckj heckj deleted the docc branch January 24, 2022 07:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Establish documentation for how to use Lindenmayer
1 participant