Commit Graph

9 Commits

Author SHA1 Message Date
Natalie Weizenbaum
058ce05454
[Containing URL] Update the specification (#3688)
See #3247
2023-09-18 23:00:25 +00:00
Natalie Weizenbaum
1f88ea8db4
Update to TypeDoc 0.24 (#3581) 2023-05-18 16:09:10 -07:00
Myles Lewando
ac8d416fe2
📝 Require correct url module in FileImporter doc (#3268) 2022-03-24 15:48:30 -07:00
Natalie Weizenbaum
23278f2c92
Use the URL type from the DOM definitions, not from Node (#3214)
The two aren't quite interchangeable: the Node definition has a few
more fields, which means that URLs created naively with `new URL()`
aren't assignable to that type.
2021-12-10 21:11:27 +00:00
Natalie Weizenbaum
b192519b55
Document the new JS API (#3183) 2021-11-30 23:32:04 +00:00
Natalie Weizenbaum
ea3d97b8d6
Replace FileImporterResult with a plain URL (#3180)
Supplying a source map URL doesn't make sense for a file importer, for
two reasons:

1. A canonical `file:` URL is already the recommended source map URL
   because it's always available on the local system.

2. Because a FileImporter doesn't know the fully-resolved canonical
   URL of the file it loads, it doesn't have any way of determining
   what the full source map URL should be anyway.
2021-10-09 01:19:02 +00:00
Natalie Weizenbaum
6fa1678aa2
Rename ImporterResult.css to ImporterResult.contents (#3175)
The name "css" is a bit misleading, since it's usually not going to be
plain CSS.
2021-10-05 20:56:18 +00:00
Natalie Weizenbaum
f289bb8c9b Test that typedoc builds with no warnings 2021-10-01 17:36:53 -07:00
Natalie Weizenbaum
1b0574a27a
Create a parallel set of type annotations for documentation (#3172)
Because the doc comments for spec/js-api are written for
implementation authors, they aren't very useful as documentation for
end-users. This gives us a place to write user-facing documentation as
well as a test that verifies that the underlying type declarations are
kept in sync.
2021-10-01 22:45:27 +00:00