archesproject / arches-docs

official repo for Arches documentation
https://arches.readthedocs.io
9 stars 20 forks source link

Made suggested updates to functions docs #442

Closed ekansa closed 1 month ago

ekansa commented 1 month ago

brief description of changes

Updates to docs about creating custom functions

issues addressed

(https://github.com/archesproject/arches-docs/issues/441)

further comments

I haven't actually designed any functions, so I'll need some guidance to make sure this is correct.

To see the updates:

  1. Function hooks: https://arches.readthedocs.io/en/funcs_7_5/developing/extending/extensions/functions/#function-hooks
  2. Function descriptions: https://arches.readthedocs.io/en/funcs_7_5/developing/extending/extensions/functions/#defining-the-function-s-details

This box must be checked

This box should be checked

This box should only be checked you intend to follow through on it (we can do it on our end too)

ekansa commented 1 month ago

@bferguso Just a quick ping to see if you could review this PR based on the issue you raise. Thanks!

mradamcox commented 1 month ago

@bferguso @ekansa FWIW, there is an explanation of how to configure the resource descriptors function in the "configuring" section: https://arches.readthedocs.io/en/stable/configuring/define-resource-descriptors/. May be worth linking to from within this new content, or updating.

ekansa commented 1 month ago

@mradamcox Thanks !!! I added a cross reference as you suggested.