Skip to content

docs: fix to_json() docstring to show accurate Python dict output - #29

Open
jannikbx wants to merge 1 commit into
mondi04:mainfrom
jannikbx:fix/to-json-docstring
Open

docs: fix to_json() docstring to show accurate Python dict output#29
jannikbx wants to merge 1 commit into
mondi04:mainfrom
jannikbx:fix/to-json-docstring

Conversation

@jannikbx

Copy link
Copy Markdown

Fixes #19

The docstring example used invalid dict literal syntax and truncated output with ..., which did not match actual behavior. Updated to show real Python dict repr output.

Before:
{"html": "

...", "component": "GreetingCard"}

After:
{'html': '

Hi
', 'component': 'GreetingCard'}

The docstring example used invalid dict literal syntax and truncated
output with ..., which didn't match actual behavior. Replaced with a
runnable example showing real Python dict repr.

Closes mondi04#19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Component.to_json() docstring shows an incorrect return value example

1 participant