Update my_secrets_example.py with note about character limit #432
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR updates the example configuration file to include a character limit requirement for the workflow name parameter. The change adds documentation to help users understand the constraint on the WORKFLOW_NAME variable.
- Adds a comment specifying that
WORKFLOW_NAMEmust be 59 characters or fewer
| CAM_NAME = "your_camera_name" | ||
| WORKFLOW_NAME = "your_workflow_name" | ||
|
|
||
| WORKFLOW_NAME = "your_workflow_name" # must be 59 characters or fewer |
There was a problem hiding this comment.
The comment should specify why there is a 59-character limit (e.g., API constraint, database field limit) to provide better context for developers.
Suggested change
| WORKFLOW_NAME = "your_workflow_name" # must be 59 characters or fewer | |
| WORKFLOW_NAME = "your_workflow_name" # must be 59 characters or fewer (AWS Step Functions API constraint) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.