framework icon indicating copy to clipboard operation
framework copied to clipboard

Documentation for field_add and field_update do not describe inputs to function

Open rxg opened this issue 2 years ago • 1 comments

Overview

Hello,

I'm new to the framework and overall I'm appreciating the workflow. Sorry if this is going to the wrong place.

I had trouble, though, understanding what the inputs to the function given to steps.field_add and steps.field_update would be. The document string doesn't say much, and the examples in the documentation (at framework.frictionlessdata.io) only used formulae and values. I looked at the implementation to deduce that the argument to steps.field_add is a row, but it looks like the function for steps.field_update takes two arguments (one of which is ignored in the formula case). Am I looking at the wrong documentation? Also, could the document string be given more detail about the type of the function?

rxg avatar Oct 22 '23 23:10 rxg

Hi @rxg, thanks for reporting! We need to fix the docs for these steps

roll avatar Nov 22 '23 10:11 roll