RFC: @version tag
See original GitHub issueCustomer often need to know the versions of particular classes, methods, and properties so they can target specific releases. While this information can be passed through the description, it would be beneficial for downstream tooling to avoid parsing extra text.
My request would be to let this field be an arbitrary string. So @version 1.1
and @version Excel API 1.4
both work.
Issue Analytics
- State:
- Created 5 years ago
- Comments:20 (4 by maintainers)
Top Results From Across the Web
RFC 4151: The 'tag' URI Scheme
RFC 4151 Tag URIs October 2005 Table of Contents 1. Introduction . ... Earlier versions of this document have been discussed on uri@w3.org....
Read more >RFC 4151:The 'tag' URI Scheme - IETF
This document describes the "tag" Uniform Resource Identifier (URI) scheme. Tag URIs (also known as "tags") are designed to be unique across space...
Read more >About the EXT-X-VERSION tag - Apple Developer
The EXT-X-VERSION tag indicates the compatibility version of the Playlist file. This file, its associated media, and its server must comply with all ......
Read more >RFC 4646 - Tags for Identifying Languages - faqs.org
The field of type 'Prefix' MUST NOT be removed from any record. The field-value for this type of field MUST NOT be modified....
Read more >HTTP/1.1: Protocol Parameters
The <major> number is incremented when the format of a message within the protocol is changed. See RFC 2145 [36] for a fuller...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
For the first version of TSDoc, can’t we leave out the added/deprecated/removed use-case and just stick to
@since
or@version
?To me, it feels like adding support for indicating when a method was deprecated or removed is another use case, which might warrant their own tags (and which can be added later), e.g.
I find
@version
to be a bit ambiguous. I would consider using@since
instead, as it clarifies that this is the version where the API is introduced (or stabilized), and another tag could be used where applicable for the version where the API is deprecated.