fix: correct entity field syntax in README code example#32
Open
ElizioMartins wants to merge 1 commit into
Open
fix: correct entity field syntax in README code example#32ElizioMartins wants to merge 1 commit into
ElizioMartins wants to merge 1 commit into
Conversation
Fields Id and String require parentheses when used as class attributes. Without `Id()` and `String()`, instantiating the entity with keyword arguments raises a TypeError at runtime. Fixes objectbox#10
This file contains hidden or 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
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.
Problem
The CRUD code example in
README.mdusesIdandStringas class attributes without parentheses:When a user copies this code and tries to instantiate
Person(name="Joe Green"), they get aTypeErrorat runtime becauseIdandStringare descriptor classes that must be instantiated (called with()) to work correctly as field definitions.This was originally reported in issue #10 back in 2021 and has been confirmed by multiple users since then.
Fix
Added the missing parentheses to both field definitions:
This matches the syntax used throughout the actual example code in the repository.
Fixes #10