bazel icon indicating copy to clipboard operation
bazel copied to clipboard

Add support for rendering HTML in markdown table cells in skydoc

Open cvarier opened this issue 4 years ago • 8 comments
trafficstars

Fixes https://github.com/bazelbuild/stardoc/issues/78.

There are multiple use cases in which we would want to support the ability to render HTML in table cells.

As described in the issue above, rendering proper lists is not possible without providing a way to avoid escaping the HTML tags in the docstring. This solution provides the ability to toggle the escaping of HTML in markdownCellFormat, without affecting existing usages of this method (particularly those in custom Velocity templates living in separate repos).

cvarier avatar Nov 05 '21 01:11 cvarier

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

:memo: Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

google-cla[bot] avatar Nov 05 '21 01:11 google-cla[bot]

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

:memo: Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

google-cla[bot] avatar Nov 05 '21 01:11 google-cla[bot]

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

:memo: Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

google-cla[bot] avatar Nov 05 '21 01:11 google-cla[bot]

@googlebot I signed it!

cvarier avatar Nov 05 '21 04:11 cvarier

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

:memo: Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

google-cla[bot] avatar Nov 05 '21 04:11 google-cla[bot]

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google. In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

google-cla[bot] avatar Nov 05 '21 19:11 google-cla[bot]

@sgowroji Can you ping someone to get this reviewed?

brentleyjones avatar Sep 09 '22 15:09 brentleyjones

tetromino@ will be back in office next month. When he returns we can discuss the broader design question of how/whether we should handle more advanced markup in docstrings. I'll leave this PR open until then.

brandjon avatar Dec 19 '22 17:12 brandjon