Skip to content

Commit 4be9fa8

Browse files
Apply suggestions from code review
Co-authored-by: Michał Olender <[email protected]>
1 parent 1d92247 commit 4be9fa8

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

sources/platform/actors/development/programming_interface/status_messages.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,14 +77,14 @@ async def main():
7777
</TabItem>
7878
</Tabs>
7979

80-
## Communicating limitations
80+
## Communicate limitations
8181

82-
If your Actor has specific limitations for users on the Apify free plan (e.g., restricted features, limited results), it is crucial to communicate these clearly to avoid confusion.
82+
If your Actor has specific limitations for users on the Apify free plan (e.g., restricted features, limited results), communicate these clearly to avoid confusion.
8383

8484
- Status messages: Use `Actor.setStatusMessage` or `Actor.exit` message to explain why a run finished early or failed (e.g., "Daily limit for free plan reached. Upgrade to continue.").
85-
- Avoid false errors: Do not return generic system errors or fail the run in a way that looks like a platform issue. This frustrates users and makes troubleshooting difficult.
85+
- Provide clear error messages: Don't return generic system errors or fail the run in a way that looks like a platform issue. This frustrates users and makes troubleshooting difficult.
8686
- Wrong: API usage is limited to 10 results
8787
- Right: This Actor only allows up to 10 results for free users. Upgrade to a paid plan to receive unlimited results.
8888
- Documentation: Clearly state any limitations in your Actor's `README` and input schema descriptions so users know what to expect before running the Actor.
8989
- General restrictions (like limiting the number of results) must be explained in the top-level input schema description that renders above the input editor UI.
90-
- Feature-specific limitations must be included in the title of an input field. The title must include explanation in parenthesis such as `(paying users only)` or `(limited for free users`). E.g. `Max comments (paying users only)`.
90+
- Feature-specific limitations must be included in the title of an input field. The title must include explanation in parenthesis such as `(paying users only)` or `(limited for free users)`. E.g. `Max comments (paying users only)`.

sources/platform/actors/publishing/monetize/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,12 +100,12 @@ If no action is taken, the payout will be automatically approved on the 14th, wi
100100

101101
If the monthly profit does not meet these thresholds, as per our [Terms & Conditions](https://apify.com/store-terms-and-conditions), the funds will roll over to the next month until the threshold is reached.
102102

103-
## Handling free users
103+
## Handle free users
104104

105-
When monetizing your Actor, you might want to limit features or usage for users on the Apify free plan. If you choose to do this, you **must** handle it transparently:
105+
When monetizing your Actor, you might want to limit features or usage for users on the Apify free plan. If you choose to do this, you _must_ handle it transparently:
106106

107107
- Communicate upfront: Clearly state any limitations in your Actor's `README` and input schema. Users should know about restrictions _before_ they run the Actor.
108-
- Graceful exits: If a free user hits a limit, do not crash the Actor or return a system error. Instead, exit gracefully with a clear [status message](/platform/actors/development/programming-interface/status-messages#communicating-limitations) explaining the limit (e.g., "Free tier limit reached").
108+
- Graceful exits: If a free user hits a limit, don't crash the Actor or return a system error. Instead, exit gracefully with a clear [status message](/platform/actors/development/programming-interface/status-messages#communicating-limitations) explaining the limit (e.g., "Free tier limit reached").
109109
- Avoid confusion: Never make a policy restriction look like a bug or platform error.
110110

111111
## Actor analytics

0 commit comments

Comments
 (0)