Skip to content

docs: fix command to ID deprecated 2.0 env vars #11613

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

Closed
wants to merge 2 commits into from
Closed

Conversation

jblz
Copy link
Contributor

@jblz jblz commented Dec 3, 2024

The command at https://ddtrace.readthedocs.io/en/stable/upgrading.html#upgrade-to-2-0 includes an extra backslash -- this commit removes it.

As-is, the command does not execute after a paste & enter -- a second enter is required. Motivation for the change is to make following the documentation to upgrade easier and more straightforward.

Since this is just a docs-only change to correct a typo, the rest of the checklist doesn't really apply.

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

@jblz jblz requested a review from a team as a code owner December 3, 2024 23:04
@jblz jblz requested a review from P403n1x87 December 3, 2024 23:04
@emmettbutler emmettbutler added the changelog/no-changelog A changelog entry is not required for this PR. label Dec 4, 2024
@github-actions github-actions bot added the stale label Feb 3, 2025
@github-actions github-actions bot removed the stale label Feb 7, 2025
@github-actions github-actions bot added the stale label Apr 8, 2025
@erikayasuda erikayasuda closed this Apr 8, 2025
@jblz
Copy link
Contributor Author

jblz commented Apr 11, 2025

cc @emmettbutler I think this is still valid if you want to get it in. I don't think I can reopen as an external contributor.
Cheers!

@emmettbutler emmettbutler reopened this Apr 11, 2025
@emmettbutler emmettbutler enabled auto-merge (squash) April 11, 2025 18:26
@emmettbutler emmettbutler self-assigned this Apr 11, 2025
@emmettbutler emmettbutler changed the title Fix command to ID deprecated 2.0 env vars docs: fix command to ID deprecated 2.0 env vars Apr 11, 2025
auto-merge was automatically disabled April 11, 2025 18:41

Pull request was closed

@jblz jblz deleted the patch-1 branch April 11, 2025 20:56
emmettbutler added a commit that referenced this pull request May 21, 2025
Internal clone of #11613

Contributed by @jblz

## Checklist
- [x] 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](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
- The change includes or references documentation updates if necessary
- Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist
- [x] 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](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
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](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)

Co-authored-by: Jeff Bowen <[email protected]>
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.

3 participants