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

Include list of Macrostrat timescales in docs #69

Closed
willgearty opened this issue Oct 14, 2024 · 1 comment
Closed

Include list of Macrostrat timescales in docs #69

willgearty opened this issue Oct 14, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@willgearty
Copy link
Owner

willgearty commented Oct 14, 2024

Sending people to the raw API list seems lazy. I propose two better options:

  1. Make the get_scale_data() docs dynamic and download and parse the Macrostrat options when the help page is loaded (this seems complicated and would break anytime there isn't internet or the Macrostrat API is down)
  2. Update the docs as part of the data-raw workflow. This would include a date that the list was compiled and then it would add the list of available timescales to the documentation. I think the easiest way to do this would be to create a template file with the list as @details that is then used in get_scale_data.R. This way we don't need to edit the get_scale_data.R file, we only ever regenerate the template file.
@willgearty willgearty self-assigned this Oct 14, 2024
@willgearty willgearty added the enhancement New feature or request label Oct 14, 2024
@willgearty
Copy link
Owner Author

willgearty commented Oct 14, 2024

Once this is done, we can then direct people to the get_scale_data docs instead of the Macrostrat API list.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant