daffodil icon indicating copy to clipboard operation
daffodil copied to clipboard

API functions are missing argument documentation

Open xelaint opened this issue 7 months ago • 4 comments

Is this a regression?

  • [ ] Yes, this behavior used to work in the previous version

Description

API functions are missing argument documentation

Image

https://next.daff.io/docs/api/cart/daffCartItemInputToItemTransform

input: DaffCartItemInput should be documented as a parameter.

Environment

  • Daffodil version: 0.84.0
  • Angular version:
  • Browser(s):
  • Node version: run node --version
  • Operating system:

Steps to reproduce

Steps to reproduce:

  1. visit https://next.daff.io/docs/api/cart/daffCartItemInputToItemTransform
  2. see that the arguments are not documented via parameters table

Expected behavior

Function arugments should be documented via parameters table.

Actual behavior

Arguments are not properly documented.

Additional context

No response

xelaint avatar May 19 '25 18:05 xelaint

@griest024 docs doesn't show up even if I add params docs.

Image Image

xelaint avatar Jun 05 '25 15:06 xelaint

https://next.daff.io/docs/api/product-composite/driver/magento/transformMagentoBundledProductItemOption has all the docs for params and doesn't show anything

griest024 avatar Jun 05 '25 15:06 griest024

A design example would be: http://next.daff.io/docs/design/components/toast?tab=api-tab#providedafftoast

config has docs.

xelaint avatar Jun 05 '25 15:06 xelaint

@griest024 reopening since this still isn't working on some pages.

https://next.daff.io/docs/design/components/toast?tab=api-tab#providedafftoast has param docs, but it's still not showing up.

https://next.daff.io/docs/api/product-composite/driver/magento/transformMagentoBundledProductItemOption seems to be working though.

xelaint avatar Aug 29 '25 18:08 xelaint