opendev/gerrit
Code Issues Proposed changes

Fix formatting of 'web_links' fields in REST API documentation

Browse Source 
The field name should be formatted as a code span. For this it must be
wrapped with backtick quotes, rather than normal single quotes.

Change-Id: I66b4391a95f53c24786ac4a3087d8b2f834d8f54
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
This commit is contained in:
Edwin Kempin 2014-11-25 16:29:47 +01:00
parent ae36719784
commit 26c95a4dbe
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/rest-api-changes.txt
View File

@ -3363,7 +3363,7 @@ The `DiffFileMetaInfo` entity contains meta information about a file diff.
|`name` ||The name of the file. |`name` ||The name of the file.
|`content_type`||The content type of the file. |`content_type`||The content type of the file.
|`lines` ||The total number of lines in the file. |`lines` ||The total number of lines in the file.
|'web_links' |optional| |`web_links` |optional|
Links to the file in external sites as a list of Links to the file in external sites as a list of
link:rest-api-changes.html#web-link-info[WebLinkInfo] entries. link:rest-api-changes.html#web-link-info[WebLinkInfo] entries.
|========================== |==========================
@ -3687,7 +3687,7 @@ entities.
|`reviewed` |optional| |`reviewed` |optional|
Indicates whether the caller is authenticated and has commented on the Indicates whether the caller is authenticated and has commented on the
current revision. Only set if link:#reviewed[REVIEWED] option is requested. current revision. Only set if link:#reviewed[REVIEWED] option is requested.
|'web_links' |optional| |`web_links` |optional|
Links to the patch set in external sites as a list of Links to the patch set in external sites as a list of
link:#web-link-info[WebLinkInfo] entities. Only set if link:#web-link-info[WebLinkInfo] entities. Only set if
link:#web-links[WEB_LINKS] option is requested. link:#web-links[WEB_LINKS] option is requested.

4
Documentation/rest-api-projects.txt
View File

@ -1790,7 +1790,7 @@ The `BranchInfo` entity contains information about a branch.
|`revision` ||The revision to which the branch points. |`revision` ||The revision to which the branch points.
|`can_delete`|`false` if not set| |`can_delete`|`false` if not set|
Whether the calling user can delete this branch. Whether the calling user can delete this branch.
|'web_links' |optional| |`web_links` |optional|
Links to the branch in external sites as a list of Links to the branch in external sites as a list of
link:rest-api-changes.html#web-link-info[WebLinkInfo] entries. link:rest-api-changes.html#web-link-info[WebLinkInfo] entries.
|========================= |=========================
@ -2157,7 +2157,7 @@ is increased for each non-visible project).
|`description` |optional|The description of the project. |`description` |optional|The description of the project.
|`state` |optional|`ACTIVE`, `READ_ONLY` or `HIDDEN`. |`state` |optional|`ACTIVE`, `READ_ONLY` or `HIDDEN`.
|`branches` |optional|Map of branch names to HEAD revisions. |`branches` |optional|Map of branch names to HEAD revisions.
|'web_links' |optional| |`web_links` |optional|
Links to the project in external sites as a list of Links to the project in external sites as a list of
link:rest-api-changes.html#web-link-info[WebLinkInfo] entries. link:rest-api-changes.html#web-link-info[WebLinkInfo] entries.
|=========================== |===========================