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

Refinement of Trace Span Specification Documentation #3266

Merged
merged 3 commits into from
May 16, 2024

Conversation

liucheng-ms
Copy link
Contributor

@liucheng-ms liucheng-ms commented May 15, 2024

Description

This PR introduces enhancements to the Markdown file detailing the trace span specification. Key changes include the addition of punctuation at the end of sentences for improved readability and the elevation of previously bolded text to higher-level titles for better document structure. These updates aim to provide clearer and more accessible documentation for contributors.

All Promptflow Contribution checklist:

  • The pull request does not introduce [breaking changes].
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.
  • Create an issue and link to the pull request to get dedicated review from promptflow team. Learn more: suggested workflow.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

@liucheng-ms liucheng-ms requested a review from a team as a code owner May 15, 2024 05:46
@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 15, 2024
@liucheng-ms liucheng-ms merged commit 8393665 into main May 16, 2024
11 checks passed
@liucheng-ms liucheng-ms deleted the liucheng/20240515_fix_doc branch May 16, 2024 06:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants