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

Remove deprecated functionality #1537

Merged
merged 17 commits into from
Apr 30, 2024

Conversation

harrism
Copy link
Member

@harrism harrism commented Apr 16, 2024

Description

Closes #1536

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

@harrism harrism added breaking Breaking change improvement Improvement / enhancement to an existing function labels Apr 16, 2024
@harrism harrism requested a review from a team as a code owner April 16, 2024 04:48
@github-actions github-actions bot added the cpp Pertains to C++ code label Apr 16, 2024
@harrism
Copy link
Member Author

harrism commented Apr 23, 2024

/merge

@harrism harrism requested a review from a team as a code owner April 23, 2024 20:34
@github-actions github-actions bot added the conda label Apr 23, 2024
@harrism harrism requested a review from a team as a code owner April 23, 2024 23:40
@github-actions github-actions bot added the Python Related to RMM Python API label Apr 23, 2024
Copy link
Contributor

@vyasr vyasr left a comment

Choose a reason for hiding this comment

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

The approach to the docs looks solid, good find. Couple of small fixes.

python/rmm/docs/conf.py Outdated Show resolved Hide resolved
python/rmm/docs/conf.py Outdated Show resolved Hide resolved
# exclude_patterns list
if not os.path.exists(breathe_projects["librmm"] + "/deprecated.xml"):
exclude_patterns.append("librmm_docs/deprecated.rst")
suppress_warnings.append("toc.excluded")
Copy link
Contributor

Choose a reason for hiding this comment

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

What is this for? I'd guess when you exclude things it generates an extra file and then it warns about that file not being included anywhere, or something like that?

Copy link
Member Author

@harrism harrism Apr 24, 2024

Choose a reason for hiding this comment

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

Because deprecated is listed in the toc in the main RST file. This lets us leave it there even though the deprecated.rst file is excluded. Without this suppression you get a warning that an excluded file is in the toc.

Copy link
Member Author

Choose a reason for hiding this comment

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

I didn't have a better way to conditionally remove it from the toc.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah OK I see. Yeah that seems fine then.

harrism and others added 2 commits April 25, 2024 07:20
Co-authored-by: Vyas Ramasubramani <vyas.ramasubramani@gmail.com>
Co-authored-by: Vyas Ramasubramani <vyas.ramasubramani@gmail.com>
@harrism
Copy link
Member Author

harrism commented Apr 30, 2024

/merge

@rapids-bot rapids-bot bot merged commit 3caaa08 into rapidsai:branch-24.06 Apr 30, 2024
52 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking Breaking change conda cpp Pertains to C++ code improvement Improvement / enhancement to an existing function Python Related to RMM Python API
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[FEA] Remove deprecated functions and classes
4 participants