Don't refer to CanonicalizeResponse.result.file (#67)

Closes #60
This commit is contained in:
Natalie Weizenbaum 2021-06-11 16:06:00 -07:00 committed by GitHub
parent d399926855
commit 888aebf97c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 5 deletions

View File

@ -8,6 +8,9 @@
* Add `CompileRequest.quiet_deps` and `CompileRequest.verbose` flags to control
how the compiler emits compilation warnings.
* Fix the documentation of `CanonicalizeRequest` to avoid referring to the
outmoded `CanonicalizeResponse.result.file` field.
[protocol buffer style guide]: https://developers.google.com/protocol-buffers/docs/style
## 1.0.0-beta.10

View File

@ -339,12 +339,14 @@ message OutboundMessage {
// format.
//
// If the URL is not recognized by this importer, or if no stylesheet is found
// at that URL, `CanonicalizeResponse.result` must be `null`.
// at that URL, `CanonicalizeResponse.result` must be `null`. Otherwise, the
// importer must return an absolute URL, including a scheme.
//
// Canonical URLs must be absolute, including a scheme. If the import is
// referring to a Sass file on disk, the importer is encouraged to respond
// with a `CanonicalizeResponse.result.file`, in which case the host will
// handle the logic of resolving partials, file extensions, and index files.
// > The host's documentation should encourage the use of file importers (via
// > `CompileRequest.Importer.file_importer_id`, `FileImportRequest`, and
// > `FileImportResponse`) for any importers that simply refer to files on
// > disk. This will allow Sass to handle the logic of resolving partials,
// > file extensions, and index files.
//
// If Sass has already loaded a stylesheet with the returned canonical URL, it
// re-uses the existing parse tree. This means that importers must ensure that