Skip to content

Commit c2bd88e

Browse files
committed
Use one sentence per line in documentation
1 parent 619e82c commit c2bd88e

1 file changed

Lines changed: 27 additions & 76 deletions

File tree

CHANGELOG.rst

Lines changed: 27 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -7,114 +7,65 @@ Changelog
77
----------
88

99
- Support database, license and target names which contain apostrophes.
10-
Such names previously produced invalid XPath expressions, so looking them
11-
up in the target manager failed.
10+
Such names previously produced invalid XPath expressions, so looking them up in the target manager failed.
1211

13-
- Support database, license and target names which contain both an
14-
apostrophe and a quotation mark, by building a ``concat()`` XPath
15-
expression for them.
12+
- Support database, license and target names which contain both an apostrophe and a quotation mark, by building a ``concat()`` XPath expression for them.
1613

17-
- Raise a descriptive error, rather than an ``IndexError``, when
18-
``get_vumark_target_id`` is asked for a target which the target manager
19-
has not yet rendered as a link.
14+
- Raise a descriptive error, rather than an ``IndexError``, when ``get_vumark_target_id`` is asked for a target which the target manager has not yet rendered as a link.
2015

21-
- Make ``get_vumark_target_id`` wait for the target manager to render a
22-
target's name as a link, rather than failing as soon as the name appears
23-
as plain text while the target is still processing.
16+
- Make ``get_vumark_target_id`` wait for the target manager to render a target's name as a link, rather than failing as soon as the name appears as plain text while the target is still processing.
2417

25-
- Make ``delete_license`` wait for the licenses page to load, rather than
26-
acting on whichever page a stale session redirects to.
18+
- Make ``delete_license`` wait for the licenses page to load, rather than acting on whichever page a stale session redirects to.
2719

28-
- Make ``navigate_to_license`` wait for the licenses page to load, rather
29-
than acting on whichever page a stale session redirects to.
20+
- Make ``navigate_to_license`` wait for the licenses page to load, rather than acting on whichever page a stale session redirects to.
3021

31-
- Make ``navigate_to_database`` wait for the target manager to load, rather
32-
than acting on whichever page a stale session redirects to.
22+
- Make ``navigate_to_database`` wait for the target manager to load, rather than acting on whichever page a stale session redirects to.
3323

34-
- Add a ``model_target_web_api_details`` context manager, which yields the
35-
same details as ``get_model_target_web_api_details`` and deletes the
36-
OAuth2 client credential it creates when the ``with`` block is left.
24+
- Add a ``model_target_web_api_details`` context manager, which yields the same details as ``get_model_target_web_api_details`` and deletes the OAuth2 client credential it creates when the ``with`` block is left.
3725

38-
- Add a ``show-model-target-web-api-details`` command, which creates and
39-
shows Model Target Web API credentials, in YAML or in
40-
``--env-var-format``.
26+
- Add a ``show-model-target-web-api-details`` command, which creates and shows Model Target Web API credentials, in YAML or in ``--env-var-format``.
4127

42-
- Add a ``delete-model-target-web-api-credentials`` command, which deletes
43-
one Model Target Web API OAuth2 client credential by its client ID.
28+
- Add a ``delete-model-target-web-api-credentials`` command, which deletes one Model Target Web API OAuth2 client credential by its client ID.
4429

45-
- Shell-quote the values which ``--env-var-format`` prints, so that output
46-
for a name containing a space or another character which is special to
47-
the shell can be used with ``eval`` or ``source``.
30+
- Shell-quote the values which ``--env-var-format`` prints, so that output for a name containing a space or another character which is special to the shell can be used with ``eval`` or ``source``.
4831

4932
- Make ``upload_vumark_template`` return the ID of the target it uploaded.
50-
It now waits for VWS to finish processing the target, which takes longer
51-
than waiting for the target to appear in the targets table.
33+
It now waits for VWS to finish processing the target, which takes longer than waiting for the target to appear in the targets table.
5234

53-
- Raise an error, rather than searching nested objects, when a Vuforia
54-
credentials API response has the wanted key at the top level but with
55-
an empty value.
35+
- Raise an error, rather than searching nested objects, when a Vuforia credentials API response has the wanted key at the top level but with an empty value.
5636

57-
- Chain the underlying ``requests`` exception onto the ``RuntimeError``
58-
raised when a call to the Vuforia credentials API fails, so that a
59-
traceback shows what went wrong at the network level.
37+
- Chain the underlying ``requests`` exception onto the ``RuntimeError`` raised when a call to the Vuforia credentials API fails, so that a traceback shows what went wrong at the network level.
6038

61-
- Stop swallowing every ``WebDriverException`` raised by the second,
62-
retried click on the add-database button, so that a real browser
63-
failure there is reported rather than turning into a later timeout.
39+
- Stop swallowing every ``WebDriverException`` raised by the second, retried click on the add-database button, so that a real browser failure there is reported rather than turning into a later timeout.
6440

65-
- Raise an error from ``create_cloud_database``, rather than silently using
66-
the first match, when more than one license in the drop-down has the
67-
requested name.
41+
- Raise an error from ``create_cloud_database``, rather than silently using the first match, when more than one license in the drop-down has the requested name.
6842

69-
- Make ``navigate_to_database`` wait for the target manager's search
70-
filter to have been applied before clicking a row, rather than
71-
clicking a row from the unfiltered table which is about to be
72-
replaced.
43+
- Make ``navigate_to_database`` wait for the target manager's search filter to have been applied before clicking a row, rather than clicking a row from the unfiltered table which is about to be replaced.
7344

74-
- Make ``delete_license`` wait for the licenses table's search filter to
75-
have been applied before clicking a row, rather than clicking a row
76-
from the unfiltered table which is about to be replaced.
45+
- Make ``delete_license`` wait for the licenses table's search filter to have been applied before clicking a row, rather than clicking a row from the unfiltered table which is about to be replaced.
7746

78-
- Raise an error from ``get_vumark_target_id`` when the last path
79-
segment of a target's link is not a target ID, rather than returning
80-
whatever the segment was.
47+
- Raise an error from ``get_vumark_target_id`` when the last path segment of a target's link is not a target ID, rather than returning whatever the segment was.
8148

82-
- Add a ``cad_data_url`` argument to
83-
``get_model_target_web_api_details``, and make the URL it defaults to
84-
public as ``MODEL_TARGET_WEB_API_CAD_DATA_URL``, so that callers can
85-
use a different model without waiting for a release of this package.
49+
- Add a ``cad_data_url`` argument to ``get_model_target_web_api_details``, and make the URL it defaults to public as ``MODEL_TARGET_WEB_API_CAD_DATA_URL``, so that callers can use a different model without waiting for a release of this package.
8650

87-
- Set Chrome's page load strategy to ``eager``, so that navigation does not
88-
wait for images and third-party scripts which no operation in this
89-
package needs.
51+
- Set Chrome's page load strategy to ``eager``, so that navigation does not wait for images and third-party scripts which no operation in this package needs.
9052

91-
- Send cookies which the browser holds for the Vuforia developer portal
92-
itself, and so have no domain attribute of their own, with requests to
93-
the Vuforia credentials API.
53+
- Send cookies which the browser holds for the Vuforia developer portal itself, and so have no domain attribute of their own, with requests to the Vuforia credentials API.
9454

95-
- Say what was received, rather than "unexpected shape", when the Vuforia
96-
credentials API returns something which is not JSON.
55+
- Say what was received, rather than "unexpected shape", when the Vuforia credentials API returns something which is not JSON.
9756

9857
2026.08.07
9958
----------
10059

101-
- Add a ``scopes`` argument to ``get_model_target_web_api_details`` so callers
102-
on Vuforia Enterprise accounts can request the advanced Model Target Web API
103-
scope alongside the standard scope, via the new
104-
``MODEL_TARGET_WEB_API_ADVANCED_SCOPES`` constant.
60+
- Add a ``scopes`` argument to ``get_model_target_web_api_details`` so callers on Vuforia Enterprise accounts can request the advanced Model Target Web API scope alongside the standard scope, via the new ``MODEL_TARGET_WEB_API_ADVANCED_SCOPES`` constant.
10561

106-
- Add ``database_id`` to the dictionary returned by ``get_database_details``,
107-
and a ``VUFORIA_DATABASE_ID`` line to the ``--env-var-format`` output of
108-
``show-database-details``.
109-
This is the ID which Cloud Targets Web API endpoints such as
110-
``POST /imagetargets/databases/{database_id}/reports/recoCounts`` name in
111-
the request path.
62+
- Add ``database_id`` to the dictionary returned by ``get_database_details``, and a ``VUFORIA_DATABASE_ID`` line to the ``--env-var-format`` output of ``show-database-details``.
63+
This is the ID which Cloud Targets Web API endpoints such as ``POST /imagetargets/databases/{database_id}/reports/recoCounts`` name in the request path.
11264

11365
2026.05.21
11466
----------
11567

116-
- Add ``get_model_target_web_api_details`` to generate OAuth2 credentials
117-
for Model Target Web API tests.
68+
- Add ``get_model_target_web_api_details`` to generate OAuth2 credentials for Model Target Web API tests.
11869

11970
2026.02.22.1
12071
------------

0 commit comments

Comments
 (0)