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

Update libraries.md for style issues #5165

Merged
merged 4 commits into from
Sep 8, 2024
Merged

Update libraries.md for style issues #5165

merged 4 commits into from
Sep 8, 2024

Conversation

theletterf
Copy link
Member

Updating the libraries page for style guide and language issues. Adding some comments where clarification might be required. This one really needed a cleanup.

@theletterf theletterf requested a review from a team September 8, 2024 14:25
@theletterf theletterf self-assigned this Sep 8, 2024
@theletterf theletterf added the docs label Sep 8, 2024
@theletterf theletterf changed the title Update libraries.md Update libraries.md for style issues Sep 8, 2024
@theletterf
Copy link
Member Author

/fix:format

@opentelemetrybot
Copy link
Collaborator

You triggered fix:format action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/10760729048

@opentelemetrybot
Copy link
Collaborator

fix:format was successful.

IMPORTANT: (RE-)RUN /fix:all to ensure that there are no remaining check issues.


WARNING: Generic solution to avoid duplication is under construction 🚧.
Copy link
Member Author

Choose a reason for hiding this comment

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

@open-telemetry/docs-approvers Do we still need this? Not a big fan of "under construction" messages in docs. It's sort of implicit and can be verified by anyone interested.

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm find with removing the more warning-y text.

span you create. Refer to
[messaging conventions](/docs/specs/semconv/messaging/messaging-spans/) for
details (WARNING: messaging conventions are
Copy link
Member Author

Choose a reason for hiding this comment

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

@open-telemetry/docs-approvers Ditto on the need for this kind of messages.


WARNING: Generic solution to avoid duplication is under construction 🚧.
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm find with removing the more warning-y text.

@theletterf theletterf added this pull request to the merge queue Sep 8, 2024
Merged via the queue into main with commit bf4bd63 Sep 8, 2024
19 checks passed
@theletterf theletterf deleted the theletterf-patch-1 branch September 8, 2024 18:51
EzzioMoreira added a commit to EzzioMoreira/opentelemetry.io that referenced this pull request Sep 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants