Establish consistent usage of 'desc' in public models #234
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
cavalle
reviewed
Feb 2, 2024
There was a problem hiding this comment.
Changes LGTM (just left one comment). Regarding impact on modules/providers, if I'm not mistaken all our modules use either Go's gobl or gobl.ruby to access GOBL documents. That means that we would need to:
- Prepare a change in
gobl.rubyupdating to the latest GOBL schema and adding backwards compatibility for the olddescname. - Update all the modules (or, at least, all that access to any description field, e.g. PDF, Plemsi, SAT-MX…) to use the latest version of
goblorgobl.rubyto ensure they'll be able to process documents with bothdescanddescriptionfields.
There was a problem hiding this comment.
No custom UnmarshalJSON for this struct as well?
There was a problem hiding this comment.
I think my though process here was that we've not seen anybody use this field, so its not worth the extra code... have you seen any exceptions?
There was a problem hiding this comment.
No, I have not. There's no need.
cavalle
approved these changes
Feb 2, 2024
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.
"desc"property name in favour of"description"which is used more widely throughout GOBL and is consistent with JSON Schema definitions.