Skip to content

Conversation

@m-murasovs
Copy link
Contributor

More code samples for the API docs. Please merge after approving 🙏

@netmilk
Copy link
Contributor

netmilk commented Dec 11, 2024

I feel like we should approach the substitutions the same way the other generated examples do that.

The users won't read the comment line and the parseable example won't throw an exception, but it will result in non-2xx. A placeholder e.g. <ACTOR ID> would throw. Another approach might be using overly obvious placeholders e.g. johndoe/foo-bar-actor.

Also, please try to prevent horizontal scrolling wherever possible.
e.g.

const { items } = await apifyClient
  .actors()
  .list();
image

@TC-MO TC-MO merged commit 5a36160 into apify:master Dec 13, 2024
4 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants