JS files not tracked as public API
Bug #1187010 reported by
Juhapekka Piiroinen
This bug affects 2 people
| Affects | Status | Importance | Assigned to | Milestone | |
|---|---|---|---|---|---|
| ubuntu-ui-toolkit (Ubuntu) |
Fix Released
|
Low
|
Cris Dywan | ||
| Vivid |
New
|
Undecided
|
Unassigned | ||
Bug Description
No developer documentation or code snippets available for mathUtils.js or any of the other JS files. Also there was no API discussion prior to implementing the functions.
If the JS files become part of the public API, they need to be added to the API checker script and components.api.
Related branches
lp://staging/~ubuntu-sdk-team/ubuntu-ui-toolkit/newJsonApiCheck
- PS Jenkins bot: Approve (continuous-integration)
- Tim Peeters: Approve
-
Diff: 4745 lines (+2521/-2131)9 files modified.bzrignore (+1/-0)
components.api (+1380/-1890)
debian/control (+1/-0)
debian/ubuntu-ui-toolkit-autopilot.install (+1/-0)
tests/apicheck/apicheck.cpp (+1106/-0)
tests/apicheck/apicheck.pro (+12/-0)
tests/qmlapicheck.py (+0/-218)
tests/qmlapicheck.sh (+18/-19)
tests/tests.pro (+2/-4)
| Changed in ubuntu-ui-toolkit: | |
| assignee: | nobody → Tim Peeters (tpeeters) |
| Changed in ubuntu-ui-toolkit: | |
| status: | New → Confirmed |
| importance: | Undecided → Low |
| Changed in ubuntu-ui-toolkit: | |
| assignee: | Tim Peeters (tpeeters) → nobody |
Revision history for this message
| Tim Peeters (tpeeters) wrote | #1 |
| summary: |
- mathUtils.js is missing documentation + Status of JS files APIs |
| description: | updated |
| description: | updated |
| Changed in ubuntu-ui-toolkit: | |
| assignee: | nobody → Christian Dywan (kalikiana) |
| tags: | added: documentation |
| Changed in ubuntu-ui-toolkit (Ubuntu): | |
| assignee: | nobody → Christian Dywan (kalikiana) |
| importance: | Undecided → Low |
| status: | New → Confirmed |
| no longer affects: | ubuntu-ui-toolkit |
| summary: |
- Status of JS files APIs + JS files not tracked as public API |
| Changed in ubuntu-ui-toolkit (Ubuntu): | |
| status: | Confirmed → In Progress |
Revision history for this message
| Launchpad Janitor (janitor) wrote | #2 |
| Changed in ubuntu-ui-toolkit (Ubuntu): | |
| status: | In Progress → Fix Released |
To post a comment you must log in.
None of the JS files have documentation, and we did not do proper API discussions for them. That needs to happen before we consider them part of the public API.