Documentation issues
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- documentation, testing
Research direction
Start with the v0.0.11 AutoAPI index and the documentation entry points for DirectThingClient, then inspect how exported names, search, and source links are configured. Done means the client can be found and its usage is explained, the import behavior is documented, and the reported search and source-view problems are resolved.
Written by the indexing model from the issue text.
Description
I am trying to work out how to directly create a DirectThingClient and not have it injected into a thing by LabThings.
I need it for testing because I think the reason a test is taking 30 seconds is that the FastAPI TestClient is taking 0.1s per request, so this adds up when trying to make lots of calls.
The docs still have a question I asked you, this somehow slipped in:
The links on this page do not link to DirectThingClient.
Trying to find the docs
- I can't find any mention in https://labthings-fastapi.readthedocs.io/en/v0.0.11/autoapi/index.html
- If I search it was not clear to me that I need to type full words or it ignores it:
The docs
Reading the docs, it is not clear to me at all whether I can make an instance? And if not, if there is something I can do?
If I attach the Thing to a server, but I have reference to it. Can I just call it?
Edited to add
- It is unclear to me what is imported with
all. I have only ever used__all__imports with pdoc, that uses this to create clear docs for what is available when you import. - Most python documentation has a way to view source code so you can see code that was documented. This doesn't seem to be working.
- Dominant language
- Python
- Stars
- 9
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Contributor guide
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.
More from labthings/labthings-fastapi
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
labthings/labthings-fastapi#405 ·
-
drop-python-version
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
labthings/labthings-fastapi#354 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
labthings/labthings-fastapi#312 · 1 comment ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
labthings/labthings-fastapi#404 · 2 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 63/100
labthings/labthings-fastapi#403 · 1 comment ·
All issues in labthings/labthings-fastapi
Similar issues
-
area: harness bug status: needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Human-Agent-Society/reef#625 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 1/5 Under an hour Newbie friendliness 80/100
learningequality/kolibri#15351 · 2 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Name consistency Open
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
eellak/triplestore#65 · 1 comment ·