refactor: project documentation #140
Merged
Conversation
This file contains 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
readme.md is broken into api.md, example.md and readme.md
reorder according to alphabetical order mostly
evanshortiss
reviewed
Nov 9, 2020
evanshortiss
reviewed
Nov 9, 2020
Co-authored-by: Evan Shortiss <evanshortiss@gmail.com>
DigiPie
commented
Nov 10, 2020
| @@ -265,8 +265,7 @@ String. It's highly unlikely that a variable will not be a String since all | |||
| #### asUrlObject() | |||
|
|
|||
| Verifies that the variable is a valid URL string using the same method as | |||
| `asUrlString()`, but instead returns the resulting URL instance. For details | |||
| see the [Node.js URL docs](https://nodejs.org/docs/latest/api/url.html#url_class_url). | |||
| `asUrlString()`, but instead returns the resulting URL instance. It uses the WHATWG URL constructor. | |||
There was a problem hiding this comment.
@evanshortiss did not accept your suggestion for this line because it would have resulted in the text becoming 'For details WHATWG URL constructor.'
Changed it to 'It uses the WHATWG URL constructor.'
Would this work?
There was a problem hiding this comment.
Looks good. I knew I'd mess up at least one suggestion 😄
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Resolves #135 .
Changelog:
API.mdandEXAMPLE.md- extract API section and secondary examples fromREADME.mdinto these filesfrom()link in API sectionLet me know what you think @evanshortiss ! You can preview this refactor at https://github.com/DigiPie/env-var/tree/docs/example