Skip to content

Commit c662b57

Browse files
committed
docs: Update README
1 parent fd3cc64 commit c662b57

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,10 @@ print("Embedding successful")
151151
With any changes to the section `A` in `main.py`, the code block section is updated in the `README` file with the next workflow run.
152152

153153
### 🧩 Object update
154-
The tag used for object update follows the same convention as the tag for section update, but you provide `object_name` instead of `section_name`, i.e. ` ```language:path/to/script:object_name`. The object name can be a function name or a class name.
154+
The tag used for object update follows the same convention as the tag for section update, but you provide `object_name` instead of `section_name`. The object name can be a function name or a class name.
155+
156+
> [!Note]
157+
> The `object_name` must match exactly the name of the object (function, class) in the script file, including the case. If you define class `Person` in the script, you must use `Person` as the object name in the `README`, not lowercase `person`.
155158
156159
For example, let's say we have the following `README` file:
157160
````md

0 commit comments

Comments
 (0)