uri: Updated documentation #10373
Merged
uri: Updated documentation #10373
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
dom96
requested changes
Jan 19, 2019
|
Yesterday I removed the deprecated procs from this module — could you rebase your branch against the latest devel? |
narimiran
requested changes
Jan 19, 2019
lib/pure/uri.nim
Outdated
| @@ -56,6 +85,10 @@ proc encodeUrl*(s: string, usePlus=true): string = | |||
| ## | |||
| ## As a special rule, when the value of ``usePlus`` is true, | |||
| ## spaces are encoded as ``'+'`` instead of ``'%20'``. | |||
There was a problem hiding this comment.
General remark: I would love to see "See also:" section which will give links to similar procs. Some examples: strutils.indent, tables.getOrDefault, etc.
Here, specifically, a link to decodeUrl would be useful. (And vice-versa)
See if you can do the same for some other procs too.
ThomasTJdev
force-pushed
the
good-documentation-uri
branch
from
31b0a0f
to
a5cf816
Compare
24 tasks
ThomasTJdev
added a commit
to ThomasTJdev/Nim
that referenced
this pull request
Jan 27, 2019
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.
Updated documentation for uri module:
refs #10330
CC @narimiran