Smart Comments
- Don't comment on what the code does - make the code self-documenting
- Use comments to explain why something is done a certain way
- Document APIs, complex algorithms
No other project uses it yet
4.9k30d agoReviewMountCreate a free account to mount
Never use apologies.
## No Understanding Feedback
Avoid giving feedback about understanding in comments or documentation.
## No Whitespace Suggestions
Don't suggest whitespace changes.
## No Summaries
Don't summarize changes made
2 projects use a version of this
4.9k30d agoReviewMountCreate a free account to mount
alwaysApply: true
---
When writing or improving documentation for Agency Swarm, your primary goal is clarity for the target reader: show the information they need to complete the task, with enough
No other project uses it yet
4.6k57d agoReviewMountCreate a free account to mount
also used in all the endpoints, see @/imageflow_core/src/context_method.rs
The JSON API is partially documented in /docs/src/json/, so when modifying or working on imageflow_types, load the whole /docs/src/json/ folder
4.5k19mo agoReviewMountCreate a free account to mount
happens before the image is decoded, and part happens afterwards.
These commands are partially documented in @/docs/src/querystring/encoding.md, @/docs/src/querystring/examples.md, @/docs/src/querystring/filters.md, @/docs/src/querystring/introduction.md, @/docs/src/querystring/transforms.md, and @/docs/src/querystring/rfc-qp.md, and we need to keep them
Steady2 mentions in 2 weeks
No other project uses it yet
4.5k19mo agoReviewMountCreate a free account to mount