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.

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

Move read_resource documentation to article #208

Closed
6 tasks done
peterdesmet opened this issue Jun 6, 2024 · 0 comments · Fixed by #246
Closed
6 tasks done

Move read_resource documentation to article #208

peterdesmet opened this issue Jun 6, 2024 · 0 comments · Fixed by #246
Assignees
Labels
complexity:low Likely not complex to implement documentation Improvements or additions to documentation enhancement New feature or request function:read_resource Function read_resource()
Milestone

Comments

@peterdesmet
Copy link
Member

peterdesmet commented Jun 6, 2024

The read_resource() documentation is very long, because it lists how all Data Resource properties are used. Cf. https://docs.ropensci.org/cffr/articles/crosswalk.html it might be good to move this info to an article and refer to it.

  • List all ignore properties as separate headings (easier to reference)
  • Make sure all field types have separate headings (easier to reference)
  • In function descriptions, link to vignette("data-package") for Data Package
  • In function descriptions, link to vignette("data-resource") for Data Resource
  • In function descriptions, link to vignette("table-dialect") for CSV Dialect
  • In function descriptions, link to vignette("table-schema") for Table Schema
@peterdesmet peterdesmet added documentation Improvements or additions to documentation enhancement New feature or request function:read_resource Function read_resource() labels Jun 6, 2024
@peterdesmet peterdesmet added this to the 1.2.0 milestone Jul 3, 2024
@peterdesmet peterdesmet added the complexity:low Likely not complex to implement label Jul 3, 2024
@peterdesmet peterdesmet removed this from the 1.2.0 milestone Jul 8, 2024
@peterdesmet peterdesmet self-assigned this Jul 9, 2024
@peterdesmet peterdesmet added this to the 1.2.0 milestone Aug 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
complexity:low Likely not complex to implement documentation Improvements or additions to documentation enhancement New feature or request function:read_resource Function read_resource()
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant