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

Allow unsetting schema comment using NULL #3649

Merged
merged 3 commits into from
Jul 3, 2024

Conversation

Anish9901
Copy link
Member

@Anish9901 Anish9901 commented Jul 2, 2024

Fixes #3638

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the develop branch of the repository
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@Anish9901 Anish9901 added the pr-status: review A PR awaiting review label Jul 2, 2024
Copy link
Contributor

@seancolsen seancolsen left a comment

Choose a reason for hiding this comment

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

As far as the behavior of msar.set_schema_description is concerned, I'm fine with this change.

However, I think this new approach would make msar.patch_schema function more like a "replace" rather than a "patch". For example, if I pass a patch argument like this...

{ "name": "my new schema name" }

...then I would not expect any changes to be made to the description. But with this PR, the description would be removed. Right? That makes patching a schema work more like replacing a schema (in terms of the standard verbs we agreed on). Perhaps I should have written another test case to assert that patching can be performed partially.

I think it would help avoid bugs in the future if this PR could also modify msar.patch_schema so that it only updates the description if the description key exists in the patch.

Whether or not you choose to make that suggested change, it would also be good to update the code comment on msar.patch_schema, so as to clarify the new behavior of that function.

@Anish9901
Copy link
Member Author

I've made your suggested change in a2529ce @seancolsen.

Copy link
Contributor

@seancolsen seancolsen left a comment

Choose a reason for hiding this comment

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

I've only just skimmed the diff, but yeah @Anish9901 that looks good.

Copy link
Contributor

@mathemancer mathemancer left a comment

Choose a reason for hiding this comment

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

Code looks fine. If the FE is okay with this behavior, so am I.

@mathemancer mathemancer added this pull request to the merge queue Jul 3, 2024
Merged via the queue into develop with commit 02c295a Jul 3, 2024
33 checks passed
@mathemancer mathemancer deleted the fix_schema_description branch July 3, 2024 06:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-status: review A PR awaiting review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unable to remove a comment on a schema
3 participants