Minor documentaiton improvements
Open
@chendaniely is already working on this.
Since Aug 20, 2025.
- Dominant language
- Python
- Stars
- 176
- Forks
- 28
- Avg merge
- 18h 42m
- Merged PRs (30d)
- 16
Description
Some notes for doc improvements as I'm going through them.
System prompt
Structured data
- would be good to know
Fieldcomes from pydantic - provide code with imports: https://posit-dev.github.io/chatlas/get-started/structured-data.html#add-descriptions
Async
- need to look into this more, but when running the code in the async section, I get this error:
RuntimeError: asyncio.run() cannot be called from a running event loop
Cell In[54], line 16
12 async for chunk in stream:
13 print(chunk)
---> 16 asyncio.run(do_stream("My name is Chatlas."))
Hide Traceback
File [~/.pyenv/versions/3.12.10/lib/python3.12/asyncio/runners.py:191](vscode-file://vscode-app/Applications/Positron.app/Contents/Resources/app/out/vs/code/electron-browser/workbench/workbench.html#), in run(main, debug, loop_factory)
161 """Execute the coroutine and return the result.
162
163 This function runs the passed coroutine, taking care of
(...)
187 asyncio.run(main())
188 """
189 if events._get_running_loop() is not None:
190 # fail fast with short traceback
--> 191 raise RuntimeError(
192 "asyncio.run() cannot be called from a running event loop")
194 with Runner(debug=debug, loop_factory=loop_factory) as runner:
195 return runner.run(main)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.