Skip to content

docs: update versioning docs #13269

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

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

Conversation

erikayasuda
Copy link
Contributor

@erikayasuda erikayasuda commented Apr 24, 2025

Remove duplicate content that will be migrated to the public docs.

PR to update the public docs: DataDog/documentation#28968

Checklist

  • PR author has checked that all the criteria below are met
  • The PR description includes an overview of the change
  • The PR description articulates the motivation for the change
  • The change includes tests OR the PR description describes a testing strategy
  • The PR description notes risks associated with the change, if any
  • Newly-added code is easy to change
  • The change follows the library release note guidelines
  • The change includes or references documentation updates if necessary
  • Backport labels are set (if applicable)

Reviewer Checklist

  • Reviewer has checked that all the criteria below are met
  • Title is accurate
  • All changes are related to the pull request's stated goal
  • Avoids breaking API changes
  • Testing strategy adequately addresses listed risks
  • Newly-added code is easy to change
  • Release note makes sense to a user of the library
  • If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment
  • Backport labels are set in a manner that is consistent with the release branch maintenance policy

@erikayasuda erikayasuda requested a review from a team as a code owner April 24, 2025 21:04
@erikayasuda erikayasuda requested a review from tabgok April 24, 2025 21:04
@erikayasuda erikayasuda added the changelog/no-changelog A changelog entry is not required for this PR. label Apr 24, 2025
Copy link
Contributor

CODEOWNERS have been resolved as:

docs/versioning.rst                                                     @DataDog/python-guild

Copy link
Contributor

Bootstrap import analysis

Comparison of import times between this PR and base.

Summary

The average import time from this PR is: 239 ± 7 ms.

The average import time from base is: 235 ± 3 ms.

The import time difference between this PR and base is: 3.7 ± 0.2 ms.

Import time breakdown

The following import paths have grown:

ddtrace.auto 0.009 ms (0.00%)
ddtrace 0.009 ms (0.00%)
ddtrace._logger 0.009 ms (0.00%)
ddtrace.internal.telemetry 0.009 ms (0.00%)
ddtrace.internal.utils.formats 0.009 ms (0.00%)
ddtrace.internal.compat 0.009 ms (0.00%)
pathlib 0.009 ms (0.00%)
ntpath 0.009 ms (0.00%)

The following import paths have shrunk:

ddtrace.auto 1.176 ms (0.49%)
ddtrace 0.658 ms (0.28%)
ddtrace.bootstrap.sitecustomize 0.517 ms (0.22%)
ddtrace.bootstrap.preload 0.517 ms (0.22%)
ddtrace.internal.products 0.517 ms (0.22%)
ddtrace.internal.remoteconfig.client 0.517 ms (0.22%)

@pr-commenter
Copy link

pr-commenter bot commented Apr 24, 2025

Benchmarks

Benchmark execution time: 2025-04-24 21:53:33

Comparing candidate commit 6a8a3ea in PR branch erikayasuda/python-versioning with baseline commit 59df167 in branch main.

Found 0 performance improvements and 2 performance regressions! Performance is the same for 498 metrics, 8 unstable metrics.

scenario:iast_aspects-ospathjoin_aspect

  • 🟥 execution_time [+714.941ns; +907.590ns] or [+11.686%; +14.835%]

scenario:iast_aspects-replace_aspect

  • 🟥 execution_time [+431.668ns; +585.069ns] or [+9.131%; +12.375%]

Copy link
Collaborator

@emmettbutler emmettbutler left a comment

Choose a reason for hiding this comment

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

The corp-docs counterpart to this information is outdated and doesn't include a mention of >=v3. Maybe link to a pull request fixing that?

@erikayasuda
Copy link
Contributor Author

The corp-docs counterpart to this information is outdated and doesn't include a mention of >=v3. Maybe link to a pull request fixing that?

@emmettbutler Oops, forgot to link the other PR. Updated the PR description with it

@emmettbutler emmettbutler self-requested a review April 25, 2025 20:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog A changelog entry is not required for this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants