New issue
Advanced search Search tips

Issue 693255 link

Starred by 1 user

Issue metadata

Status: Fixed
Owner:
Closed: Apr 2017
Cc:
Components:
EstimatedDays: ----
NextAction: ----
OS: ----
Pri: 3
Type: Bug



Sign in to add a comment

chrome.accessibilityFeatures API documentation formatting issue

Project Member Reported by michae...@chromium.org, Feb 16 2017

Issue description

https://developer.chrome.com/extensions/accessibilityFeatures#property-stickyKeys has some sort of HTML issue where the table and article are closed in the middle of this function description, causing all the later API functions to span the entire width of the page.
 
Owner: lazyboy@chromium.org
Status: Assigned (was: Untriaged)
lazyboy@ intrepidly agreed to look into this.
Project Member

Comment 2 by bugdroid1@chromium.org, Mar 15 2017

The following revision refers to this bug:
  https://chromium.googlesource.com/chromium/src.git/+/2691c6929de42bf5845162fe9df31270c9b38b18

commit 2691c6929de42bf5845162fe9df31270c9b38b18
Author: lazyboy <lazyboy@chromium.org>
Date: Wed Mar 15 02:10:53 2017

Fix rendering functions of "properties" of an api object

There aren't many api properties that have functions, so this wasn't
thoroughly checked I'm assuming. accessibilityFeatures has one such
example.

Rendering <table> content (body) without <tr> is bad idea, it messes
up rendering the table. What happens in the broken case for
accessibilityFeatures is that rows (2nd and onwards) are pushed out of
table t1 below:
<table id="t1">
  <tr><td>
    <table id="t2"> <!-- no tr/td -->
      <table><tr><td>A</td></tr></table>
    </table>
  </td></tr>
  <tr><td>This row will be pushed out of t1</td></tr>
</table>

Live example can be seen at:
http://lazyboy.github.io/pages/markup/valid_table.html
http://lazyboy.github.io/pages/markup/invalid_table.html

Therefore this CL wraps function template with <tr><td> when called
from api_property template. The function template already have
condition to add <tr><td> though, based on parentName param. However
there are cases where we want to preserve that (api_property template).
It seemed safer to me to wrap the callsite.

BUG= 693255 
Test=Check largeCursor documentation in
https://developer.chrome.com/apps/accessibilityFeatures#property-largeCursor
The entry should be rendered within a table.

Review-Url: https://codereview.chromium.org/2727573006
Cr-Commit-Position: refs/heads/master@{#456950}

[modify] https://crrev.com/2691c6929de42bf5845162fe9df31270c9b38b18/chrome/common/extensions/docs/templates/private/api_property.html

Status: Fixed (was: Assigned)

Sign in to add a comment