Skip to content

Commit bac06ce

Browse files
ehsanframnes
authored andcommitted
Adding some tips to README
1 parent 72924cd commit bac06ce

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,15 @@ Pet({'type': 'donkey', 'created_by': User({'name': 'Beatrix Emery', ...}), ...})
101101
* Delete stuff!
102102

103103
```python
104-
>>> constraints = [{'key': 'name', 'constraint_type': 'equals', 'value': 'Beatrix Emery'}]
104+
>>> constraints = [{"key": "name", "constraint_type": "equals", "value": "Beatrix Emery"}]
105105
>>> pet = await Project.get_one(constraints=constraints)
106106
>>> await pet.delete()
107+
```
108+
109+
Tips
110+
----
111+
112+
* Use `asyncio.run(main())` if you are getting a `SyntaxError` (it means that you can't use
113+
async/await in the main body of a Python code).
114+
* Avoid using dashes in table names (Python object names can't have a dash).
115+
* The base URL doesn't need the `/api/1.1/obj` part.

0 commit comments

Comments
 (0)