OpenRefine / OpenRefine/openrefine.org
Clarify that client-server protocol is unsupported and internal use only
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 161
- Forks
- 142
- Avg merge
- 6h 10m
- Merged PRs (30d)
- 9
Description
The current wording is
NOTE: This protocol is subject to change without warning at any time (and has in the past) and is not versioned. Use at your own risk!
which means, more or less, the same thing, but I think "internal use only" and "unsupported" would be more direct and clearer.
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.
Research direction
Search the site source for the quoted protocol note and read the surrounding documentation. Replace the indirect warning with wording that explicitly says the client-server protocol is for internal use only and unsupported, then check the rendered page to confirm the note is clear.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100