etl icon indicating copy to clipboard operation
etl copied to clipboard

docs: add guide "using `etl` utils" (with examples, code snippets, etc)

Open lucasrodes opened this issue 11 months ago • 1 comments

One-liner

We have multiple tools in etl and owid.catalog ready to be used, but they are not visible to users.

Context & details

As we develop and add more functionalities to our libraries, it is hard to track all of these. We should have a space in our docs to list the most commonly used code snippets.

I propose starting with a guide named "using etl utils" (or something similar). In this section, we should have various subsections with these common usages. Some candidate subsections could be:

  • Correctly aggregate data (continents, World, world bank income, etc.)
  • Copying metadata between indicators, tables, etc.
  • Log your script (paths.log)

Feel free to add other actions that you think should have a place in this guide.

Deadline

I will work on a first draft at some point during 2024Q3 (maybe cooldown).

lucasrodes avatar Mar 11 '24 10:03 lucasrodes

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar May 13 '24 20:05 stale[bot]