Add version badge to docs referencing file.size #1641
Conversation
docs/files.md
Outdated
| @@ -52,7 +52,7 @@ const frames = [ | |||
|
|
|||
| None of the files in `frames` above are loaded until a [content method](#supported-formats) is invoked, for example by saying `frames[0].image()`. | |||
|
|
|||
| For missing files, `file.size` and `file.lastModified` are undefined. The `file.mimeType` is determined by checking the file extension against the [`mime-db` media type database](https://github.com/jshttp/mime-db); it defaults to `application/octet-stream`. | |||
| For missing files, `file.size` <a href="https://github.com/observablehq/framework/releases/tag/v1.11.0" class="observablehq-version-badge" data-version="^1.11.0" title="Added in 1.11.0"></a> and `file.lastModified` are undefined. The `file.mimeType` is determined by checking the file extension against the [`mime-db` media type database](https://github.com/jshttp/mime-db); it defaults to `application/octet-stream`. | |||
There was a problem hiding this comment.
Do you want to add <a href="https://github.com/observablehq/framework/releases/tag/v1.4.0" class="observablehq-version-badge" data-version="^1.4.0" title="Added in 1.4.0"></a> for file.lastModified too?
There was a problem hiding this comment.
Sure that makes sense to me! 👍
There was a problem hiding this comment.
I think the compromise here is that we should explicitly document the names of these fields the first time they are introduced, along with the version at which they were added. Then we won’t repeat the version badge when they are referenced subsequently. The problem with these fields is that we only introduce them as e.g. “size in bytes” and “modification time” rather than file.size and file.lastModified. I’ll make some edits and approve.
There was a problem hiding this comment.
Okay, hopefully this makes it more obvious when file.size was added. I’ll merge this but let us know if you’d like further changes. Thank you @gvanhorne!
Closes #1640