Descriptions and markdown quality
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 755
- Forks
- 128
- PR merge metrics
- No merged PRs in 30d
Description
Description
So descriptions of datasets seems to be in markdown. But there are also many issues with many descriptions, examples:
- https://www.openml.org/d/40536 has the whole list of attributes in the code block.
- https://www.openml.org/d/42166 has an extra space which makes a large code block.
So how we assure quality of those descriptions? I think first would be to show rendered output to users. But it is also unclear which library/dialect of Markdown are we supporting?
Another unclear question how it is easy to contribute fixes to descriptions. Can only dataset uploaders change descriptions?
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.
Research direction
Start by comparing the dataset descriptions at openml.org/d/40536 and openml.org/d/42166 with their linked GitLab examples. Determine the supported Markdown dialect, how rendered output should be shown, and who may edit descriptions. Done means the rendering and contribution rules are defined clearly enough to guide implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- content, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100