Skip to content

Commit

Permalink
Add an explicit note about drive letter colons
Browse files Browse the repository at this point in the history
  • Loading branch information
DanTup committed Aug 8, 2023
1 parent 8d13cb2 commit 066048f
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions _includes/types/uri.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@ We also maintain a node module to parse a string into `scheme`, `authority`, `pa

Many of the interfaces contain fields that correspond to the URI of a document. For clarity, the type of such a field is declared as a `DocumentUri`. Over the wire, it will still be transferred as a string, but this guarantees that the contents of that string can be parsed as a valid URI.

Care should be taken to handle encoded in URIs. Some clients (such as VS Code) may encode colons in drive letters while others do not. The following URIs should be considered equivalent and are both valid for clients and servers to use:

```
file:///c:/project/readme.md
file:///c%3A/project/readme.md
```

<div class="anchorHolder"><a href="#documentUri" name="documentUri" class="linkableAnchor"></a></div>

```typescript
Expand Down

0 comments on commit 066048f

Please sign in to comment.