Skip to content

docs: make dartdoc examples self-contained#281

Open
miachillgood wants to merge 1 commit into
google:masterfrom
miachillgood:docs/self-contained-dartdoc-examples
Open

docs: make dartdoc examples self-contained#281
miachillgood wants to merge 1 commit into
google:masterfrom
miachillgood:docs/self-contained-dartdoc-examples

Conversation

@miachillgood
Copy link
Copy Markdown

Closes #101.

Summary

  • Wrap dartdoc examples that include imports in main() functions so they can be copied into runnable Dart files.
  • Use Future<void> main() async for examples that await webcrypto APIs and void main() for the random-byte example.
  • Fix a few keypair/wording typos in the touched examples while preserving the documented APIs.

Validation

  • git diff --check
  • Custom script verified all dartdoc dart code blocks with imports now include a main() function.

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.

Make dartdoc examples self-contained.

1 participant