fix: remove 'contents' parameter from remove_notes #8209
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Project notes have name and contents. There is no uniqueness constraint on name within a project. This gives an awkward interface for removing a note by its name. Previously, we had logic that optionally took a "contents", so a user could narrow down _which_ note to delete when multiple notes had the name as the note to be removed. But this interface is complicated, and what's the likelihood that a user will event want it. Even more, we hadn't implemented all the if/then casing right with "contents", and this method had a bug as implemented. This fixes the bug by removing the feature.
✅ Deploy Preview for determined-ui canceled.
|
wes-turner
added
the
to-cherry-pick
dai-release bot
pushed a commit
that referenced
this pull request
Oct 20, 2023
Project notes have name and contents. There is no uniqueness constraint on name within a project. This gives an awkward interface for removing a note by its name. Previously, we had logic that optionally took a "contents", so a user could narrow down _which_ note to delete when multiple notes had the name as the note to be removed. But this interface is complicated, and what's the likelihood that a user will event want it. Even more, we hadn't implemented all the if/then casing right with "contents", and this method had a bug as implemented. This fixes the bug by removing the feature. (cherry picked from commit facdc30)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Project notes have name and contents. There is no uniqueness constraint on name within a project. This gives an awkward interface for removing a note by its name.
Previously, we had logic that optionally took a "contents", so a user could narrow down which note to delete when multiple notes had the name as the note to be removed. But this interface is complicated, and what's the likelihood that a user will event want it. Even more, we hadn't implemented all the if/then casing right with "contents", and this method had a bug as implemented.
This fixes the bug by removing the feature.
Description
Test Plan
Test
remove_notefunctionality for when multiple notes of the same name exist. These notes can be added in the web UI or withProject.add_note. Ex:Commentary (optional)
Checklist
docs/release-notes/.See Release Note for details.
Ticket