crawlee icon indicating copy to clipboard operation
crawlee copied to clipboard

Crawlee docs - the default values are wrongly displayed

Open katacek opened this issue 2 years ago • 1 comments

Which package is this bug report for? If unsure which one to select, leave blank

None

Issue description

see this page and prnt scrn

blockedStatusCodes - should be [401, 403, 429] but is = number[] maxPoolSize - should be 1000 but is ````ts 1000`` etc

Screenshot 2024-01-03 at 16 02 27

Code sample

No response

Package version

not relevant

Node.js version

not relevant

Operating system

No response

Apify platform

  • [ ] Tick me if you encountered this issue on the Apify platform

I have tested this on the next release

No response

Other context

No response

katacek avatar Jan 03 '24 15:01 katacek

I thought this may be a trivial one, but it's not. What I've figured out:

  • in the typedoc JSON output, the default is stored in blockTags under the comment field of the declaration
    • default values that work as expected (e.g., BASIC_CRAWLER_TIMEOUT_BUFFER_SECS) have the default under default in the declaration
  • the "```ts" code fence is added by typedoc, apparently in the case when there is no explicit code block in the @default tag
  • the number[] in blockedStatusCodes seems to be some kind of a default for kinda-complex types. After changing the type of the property to string, I got a code block, just like for the other properties

janbuchar avatar Feb 23 '24 15:02 janbuchar