Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for rendering HTML in markdown table cells in skydoc #14230

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

cvarier
Copy link

@cvarier cvarier commented Nov 5, 2021

Fixes bazelbuild/stardoc#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).

@google-cla
Copy link

google-cla bot commented Nov 5, 2021

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).

📝 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 google-cla bot added the cla: no label Nov 5, 2021
@cvarier cvarier force-pushed the support-html-in-md-table-cells branch from 0d1d847 to 9535fa4 Compare November 5, 2021 01:34
@google-cla
Copy link

google-cla bot commented Nov 5, 2021

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).

📝 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.

@cvarier cvarier force-pushed the support-html-in-md-table-cells branch from 9535fa4 to ccd1637 Compare November 5, 2021 01:38
@google-cla
Copy link

google-cla bot commented Nov 5, 2021

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).

📝 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.

@cvarier
Copy link
Author

cvarier commented Nov 5, 2021

@googlebot I signed it!

@google-cla
Copy link

google-cla bot commented Nov 5, 2021

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).

📝 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.

@cvarier cvarier force-pushed the support-html-in-md-table-cells branch from ccd1637 to 5066d54 Compare November 5, 2021 04:28
@google-cla google-cla bot added cla: yes and removed cla: no labels Nov 5, 2021
@google-cla
Copy link

google-cla bot commented Nov 5, 2021

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 google-cla bot added cla: no and removed cla: yes labels Nov 5, 2021
@cvarier cvarier force-pushed the support-html-in-md-table-cells branch from 128560e to dc223a8 Compare November 5, 2021 19:41
@google-cla google-cla bot added cla: yes and removed cla: no labels Nov 5, 2021
@gregestren gregestren added the team-Starlark-Integration Issues involving Bazel's integration with Starlark, excluding builtin symbols label Feb 3, 2022
@sgowroji sgowroji requested a review from brandjon April 27, 2022 07:58
@sgowroji sgowroji added the awaiting-review PR is awaiting review from an assigned reviewer label Apr 27, 2022
@brentleyjones
Copy link
Contributor

@sgowroji Can you ping someone to get this reviewed?

@Wyverald Wyverald requested review from tetromino and removed request for c-parsons September 16, 2022 15:38
@brandjon
Copy link
Member

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 brandjon removed the awaiting-review PR is awaiting review from an assigned reviewer label Dec 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes team-Starlark-Integration Issues involving Bazel's integration with Starlark, excluding builtin symbols
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support lists in Description column
5 participants