Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve individual data set documentation. #316

Closed
seabbs opened this issue Apr 25, 2021 · 2 comments
Closed

Improve individual data set documentation. #316

seabbs opened this issue Apr 25, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed no-issue-activity

Comments

@seabbs
Copy link
Contributor

seabbs commented Apr 25, 2021

Some datasets, such as the UK, a large number of custom methods that are currently only partially documented + supported with examples. Ideally, this documentation would be expanded to better surface what is supported and how.
@seabbs seabbs added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Apr 25, 2021
@seabbs
Copy link
Contributor Author

seabbs commented May 7, 2021

In 86a805d added cross links between related functions which may partially help with this. Documentation is still quite sparse and unhelpful. In particular, lack of examples and descriptions of the data sources are a bit of a problem.

@joseph-palmer joseph-palmer mentioned this issue May 24, 2021
Closed
40 tasks
@RichardMN RichardMN mentioned this issue Jun 9, 2021
Closed
@joseph-palmer joseph-palmer mentioned this issue Jun 10, 2021
Merged
12 tasks
@github-actions
Copy link

github-actions bot commented Jul 7, 2021

This issue has been flagged as stale due to lack of activity

@seabbs seabbs reopened this Jul 15, 2021
@kathsherratt kathsherratt reopened this Jul 23, 2021
@seabbs seabbs reopened this Aug 2, 2021
@seabbs seabbs closed this as completed Aug 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed no-issue-activity
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@seabbs @kathsherratt