googleapis / googleapis/librarian

sidekick: goldmark is still missing some cases of html tags

Open
#3,052 0 comments 0 reactions 0 assignees View on GitHub
sidekick
Dominant language
Go
Stars
45
Forks
61
Avg merge
19h 11m
Merged PRs (30d)
181

Description

The markdown comments in googleapis include HTML-looking tags, such as `

Sidekick uses `goldmark` to escape the HTML-looking tags to `\`. It is missing some (an example is below. We should fix this problem.

----

Generating `google/cloud/aiplatform/v1` and calling `cargo doc` is resulting in the following issue:
```
warning: unclosed HTML tag `annotation-type`
--> src/generated/cloud/aiplatform/v1/src/model.rs:71565:60
|
71565 | /// "bigquery_destination.dataset_\__\.validation"
| ^^^^^^^^^^^^^^^^^
|
help: try marking as source code
|
71565 | /// "bigquery_destination.dataset_\`_`_\.validation"
| + +

warning: unclosed HTML tag `annotation-type`
--> src/generated/cloud/aiplatform/v1/src/model.rs:71568:60
|
71568 | /// "bigquery_destination.dataset_\__\.test"
| ^^^^^^^^^^^^^^^^^
|
help: try marking as source code
|
71568 | /// "bigquery_destination.dataset_\`_`_\.test"
| + +

```

Interestingly, `"gcs_destination/dataset---

Contributor guide

Open the contributing guide

Research direction

Start by reproducing generation for google/cloud/aiplatform/v1 and running cargo doc, then trace Sidekick's goldmark HTML-escaping path. Compare the failing annotation-type and time examples with the correctly escaped gcs_destination example; done means the generated Rust documentation produces no corresponding unclosed HTML tag warnings.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.