Document client construction better
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Review the current API documentation for ModelManagerClient and related clients, then read the internal BaseClient documentation for the existing construction guidance. Update the public documentation so newcomers can see how to create each client instance, and verify that the resulting API docs expose this guidance clearly.
Written by the indexing model from the issue text.
Description
From the current API docs for ModelManagerClient and friends, it is not obvious how to create an instance. This knowledge is hidden in the "internal" documentation for BaseClient.
- Dominant language
- Jupyter Notebook
- Stars
- 20
- Forks
- 6
- 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 SAP/data-attribute-recommendation-python-sdk
-
Update Dependencies Open
Difficulty 4/5 3-5 days Newbie friendliness 30/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
-
Difficulty 4/5 3-5 days Newbie friendliness 20/100
-
Difficulty 5/5 Over a week Newbie friendliness 15/100
-
Ensure thread safety Open
Difficulty 5/5 Over a week Newbie friendliness 25/100
All issues in SAP/data-attribute-recommendation-python-sdk
Similar issues
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·