Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add "version added" annotations to API documentation #1353

Closed
Krinkle opened this issue Feb 10, 2015 · 3 comments · Fixed by #1462
Closed

Add "version added" annotations to API documentation #1353

Krinkle opened this issue Feb 10, 2015 · 3 comments · Fixed by #1462
Assignees
@Krinkle
Labels
Category: Docs

Comments

@Krinkle
Copy link
Member

Krinkle commented Feb 10, 2015

Similar to http://api.jquery.com/on/

version added: 1.7

Pages like http://api.qunitjs.com/async/ should mention e.g. "version added: 1.16".

Would help a lot. Especially when working with frameworks that may abstract how or which QUnit is being loaded.
@JamesMGreene
Copy link
Member

I concur. 👍

@leobalter
Copy link
Member

leobalter commented Feb 10, 2015 •
edited by Krinkle
Loading

👍 as this should work independently from qunitjs/qunitjs.com#86.

@Krinkle Krinkle transferred this issue from qunitjs/api.qunitjs.com Dec 29, 2018
@Krinkle Krinkle self-assigned this Jul 8, 2020
Krinkle added a commit that referenced this issue Jul 8, 2020
@Krinkle
[WIP] Align with qunitjs.com design
051c86f 
* Use the same fonts, colors, and header.

* Add footer.

* Experiment splitting method name headings from method
  signatures. This is in preparation for
  #1353.
  I'll submit this for review separately though.

* Use the same highlight styles.
  I'll submit this separately though.
Krinkle added a commit that referenced this issue Jul 9, 2020
@Krinkle
[WIP] Align with qunitjs.com design
0cd373a 
* Use the same fonts, colors, and header.

* Use the same highlight styles.

* Add missing footer.

* Split the method name heading from the method signature.
  This is in preparation for
  #1353.
Krinkle added a commit that referenced this issue Jul 11, 2020
@Krinkle
Design refresh to align with the new qunitjs.com
5482357 
* Use the same fonts, colors, header, and syntax highlight styles.

* Add the same footer.

* Split the method name heading from the method signature.
  This is in preparation for #1353.

* On narrow viewports:
  - Hide the sidebar on narrow viewports (redundant with header
    menu).
  - Let tables scroll horizontally instead of widening the page.

Ref #1458
Krinkle added a commit that referenced this issue Jul 11, 2020
@Krinkle
Design refresh to align with the new qunitjs.com
b50e2c5 
* Use the same fonts, colors, header, and syntax highlight styles.

* Add the same footer.

* Split the method name heading from the method signature.
  This is in preparation for #1353.

* On narrow viewports:
  - Hide the sidebar on narrow viewports (redundant with header
    menu).
  - Let tables scroll horizontally instead of widening the page.

Ref #1458
Krinkle added a commit that referenced this issue Jul 20, 2020
@Krinkle
Docs: Design update to align with the new qunitjs.com
a66c0bc 
* Add new search functionality.

* Add new footer.

* Match the fonts, colors, header, and syntax highlight styles.

* Split the method name heading from the method signature.
  This is in preparation for #1353.

* On narrow viewports:
  - Hide the sidebar on narrow viewports (redundant with header
    menu).
  - Let tables scroll horizontally instead of widening the page.

Closes #1458
@Krinkle
Copy link
Member Author

Krinkle commented Jul 21, 2020 •
edited
Loading

To make the changelog links in the interface for this easier to manage, I've backfilled release tags for some of the 1.x releases that didn't have them in the new tag name format.

Before:

# old-style
v1.0.0
v1.1.0
v1.2.0
v1.3.0
v1.4.0
v1.5.0
v1.6.0
v1.7.0
v1.8.0
v1.9.0
v1.10.0
v1.11.0
v1.12.0
v1.13.0
v1.14.0

# new-style
1.1.0
1.9.0
1.11.0
1.12.0
1.13.0
1.14.0
1.15.0
1.16.0
1.17.0
1.17.1
1.18.0
1.19.0
1.20.0
1.21.0
1.22.0
1.23.0
1.23.1
2.0.0
2.0.1
2.1.0
2.1.1
2.2.0
2.2.1
2.3.0
2.3.1
2.3.2
2.3.3
2.4.0
…

There were new-style release tags for 1.1.0, 1.9.0, and anything after 1.11.0. But not for 1.0, 1.2-1.8, and 1.10. This is now fixed.

Krinkle added a commit that referenced this issue Jul 21, 2020
@Krinkle
Docs: Add "version added" to all methods
6594193 
Those marked as added in 1.0 were confirmed via source at:
<https://github.com/qunitjs/qunit/blob/1.0.0/qunit/qunit.js#L254>.

The others based on release notes in History.md.

Fixes #1353.
@Krinkle Krinkle mentioned this issue Jul 21, 2020
Merged
Krinkle added a commit that referenced this issue Jul 21, 2020
@Krinkle
Docs: Add "version added" to all methods
7db059d 
Those marked as added in 1.0 were confirmed via source at:
<https://github.com/qunitjs/qunit/blob/1.0.0/qunit/qunit.js#L254>.

The others based on release notes in History.md.

Fixes #1353.
Krinkle added a commit that referenced this issue Jul 26, 2020
@Krinkle
Docs: Add "version added" to all methods
76f5174 
Those marked as added in 1.0 were confirmed via source at:
<https://github.com/qunitjs/qunit/blob/1.0.0/qunit/qunit.js#L254>.

The others based on release notes in History.md.

Fixes #1353.
Closes #1462.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Krinkle Krinkle

Labels
Category: Docs
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Docs: Add "version added" to all methods qunitjs/qunit
3 participants
@Krinkle @leobalter @JamesMGreene