Skip to content

Adjust agent skills to encourage the use of comments when making auxillary changes #1516

@nathanjmcdougall

Description

@nathanjmcdougall

In #1510, the agent was working on a feature, but it realized that the test was failing due to a rather peripheral issue, unrelated to the main change.

In particular, it realized that there was a bracket notation [] that came up in a message, and it needed to add markup=False to console pretty-printing to prevent this being interpreted as a special markup syntax.

When I came to review the PR, I didn't have that context. The general principle is that auxillary changes that aren't directly related to the current task but are "pre-existing"/latent should almost always be documented with a code comment explaining the context for the decision.

We should update our usethis-python-code-modify skill accordingly.

Metadata

Metadata

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions