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

Add improved docs #11

Merged
merged 2 commits into from
Dec 8, 2021
Merged

Add improved docs #11

merged 2 commits into from
Dec 8, 2021

Conversation

wooorm
Copy link
Member

@wooorm wooorm commented Dec 3, 2021

Initial checklist

  • I read the support docs
  • I read the contributing guide
  • I agree to follow the code of conduct
  • I searched issues and couldn’t find anything (or linked relevant results below)
  • If applicable, I’ve added docs and tests

Description of changes

View rendered

Related-to: unifiedjs/unified#168.

/cc @nemo-omen @remcohaszing @ChristianMurphy @Murderlon @with-heart @joostdecock @mgan59

@wooorm wooorm added the 📚 area/docs This affects documentation label Dec 3, 2021
@github-actions github-actions bot added 👋 phase/new Post is being triaged automatically 🤞 phase/open Post is being triaged manually and removed 👋 phase/new Post is being triaged automatically labels Dec 3, 2021
@codecov-commenter

This comment has been minimized.

Copy link
Member Author

@wooorm wooorm left a comment

Choose a reason for hiding this comment

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

readme.md Outdated Show resolved Hide resolved
console.error(reporter(file))
console.log(String(file))
})
main()
Copy link
Member

Choose a reason for hiding this comment

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

Not a blocker, but use before define could cause more confusion here.
with the example as is, with a async function main() { this works fine, but if const main = async () => { is used it will break.

Copy link
Member Author

Choose a reason for hiding this comment

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

noted, I’ll keep my ear to the ground for others’ opinions

Co-authored-by: Christian Murphy <[email protected]>
@wooorm wooorm merged commit f1f49dd into main Dec 8, 2021
@wooorm wooorm deleted the docs branch December 8, 2021 13:27
@wooorm wooorm added the 💪 phase/solved Post is done label Dec 8, 2021
@github-actions

This comment has been minimized.

@github-actions github-actions bot removed the 🤞 phase/open Post is being triaged manually label Dec 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 area/docs This affects documentation 💪 phase/solved Post is done
Development

Successfully merging this pull request may close these issues.

5 participants