Skip to content

feat(docs): add fluxdoc formatting documentation #4210

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

Merged
merged 2 commits into from
Nov 5, 2021

Conversation

sanderson
Copy link
Contributor

This change adds documentation about inline standard library documentation and fluxdoc-compliant formatting. It also updates the contributing guide to point to the new fluxdoc formatting guide.

Done checklist

  • docs/SPEC.md updated N/A
  • Test cases written N/A
Siteproxy
Copy link
Contributor

@nathanielc nathanielc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great thanks for writing this up. I have a few questions below.

@sanderson sanderson requested a review from nathanielc November 5, 2021 20:47
@sanderson sanderson merged commit 13fa707 into master Nov 5, 2021
@sanderson sanderson deleted the fluxdoc-formatting-readme branch November 5, 2021 20:59
pierwill pushed a commit that referenced this pull request Nov 8, 2021

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
* feat(docs): add fluxdoc formatting documentation

* feat(docs): add package examples and long param descriptions to fluxdoc readme
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.

None yet

2 participants