Skip to content

VertexAI fix RST title underline #3292

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Feb 24, 2025
Merged

VertexAI fix RST title underline #3292

merged 1 commit into from
Feb 24, 2025

Conversation

@aabmass
Copy link
Member

@aabmass aabmass commented Feb 24, 2025 •
edited
Loading

Description

This makes twine/PyPI happy:

ERROR    `long_description` has syntax errors in markup and would not be rendered on PyPI.
         line 2: Warning: Title underline too short.

         OpenTelemetry VertexAI Instrumentation
         ====================================

See failed release workflow https://github.com/open-telemetry/opentelemetry-python-contrib/actions/runs/13504058843/job/37729358495

Type of change

Please delete options that are not relevant.

  • This change requires a documentation update

How Has This Been Tested?

Built a dist and checked with twine:

$ uvx twine check dist/*
Checking dist/opentelemetry_instrumentation_vertexai-2.1b0.dev0-py3-none-any.whl: PASSED
Checking dist/opentelemetry_instrumentation_vertexai-2.1b0.dev0.tar.gz: PASSED

Does This PR Require a Core Repo Change?

  • Yes. - Link to PR:
  • No.

Checklist:

See contributing.md for styleguide, changelog guidelines, and more.

  • Documentation has been updated

@aabmass aabmass added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Feb 24, 2025
@aabmass aabmass marked this pull request as ready for review February 24, 2025 17:53
@aabmass aabmass requested a review from a team as a code owner February 24, 2025 17:53
emdneto
emdneto approved these changes Feb 24, 2025
View reviewed changes
Copy link
Member

@emdneto emdneto left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We didn't catch up earlier because we are skipping docs at CI?
Nvm, we are not importing this in docs

@aabmass aabmass merged commit b76119b into open-telemetry:main Feb 24, 2025
694 of 695 checks passed
@aabmass aabmass deleted the vertex-readme-underline branch February 24, 2025 18:07
aabmass added a commit to aabmass/opentelemetry-python-contrib that referenced this pull request Feb 24, 2025
@aabmass
VertexAI fix RST title underline (open-telemetry#3292)
d93582a
@aabmass aabmass mentioned this pull request Feb 24, 2025
Merged
6 tasks
aabmass added a commit that referenced this pull request Feb 24, 2025
@aabmass
VertexAI fix RST title underline (#3292) (#3293)
e728ed7
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@emdneto emdneto emdneto approved these changes

@lzchen lzchen lzchen approved these changes

@alizenhom alizenhom Awaiting requested review from alizenhom

@codefromthecrypt codefromthecrypt Awaiting requested review from codefromthecrypt

@gyliu513 gyliu513 Awaiting requested review from gyliu513

@karthikscale3 karthikscale3 Awaiting requested review from karthikscale3

@lmolkova lmolkova Awaiting requested review from lmolkova

@nirga nirga Awaiting requested review from nirga

Assignees

@codefromthecrypt codefromthecrypt

@lmolkova lmolkova

@nirga nirga

@gyliu513 gyliu513

@lzchen lzchen

@karthikscale3 karthikscale3

@alizenhom alizenhom

Labels

Skip Changelog PRs that do not require a CHANGELOG.md entry

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

9 participants

@aabmass @emdneto @lzchen @codefromthecrypt @lmolkova @nirga @gyliu513 @karthikscale3 @alizenhom