docs(guide/dev): pipe-trait usage#361
Merged
Merged
Conversation
Performance Regression Reportscommit: 8b6c0dc There are no regressions. |
The key pattern is chaining through any unary callable, not specifically constructors or newtypes — those are just common instances. https://claude.ai/code/session_01DQYEAgJo7PnTgu9ejF1N1p
Contributor
There was a problem hiding this comment.
Pull request overview
Adds formal guidance on using the pipe-trait Pipe trait across the repository, clarifying when piping improves readability (continuing chains, avoiding nested calls) and when it should be avoided (standalone unary calls).
Changes:
- Documented
pipe-traitusage patterns (including.pipe_as_ref()) inCONTRIBUTING.md. - Updated agent/instruction docs to include the new
pipe-traitguideline as a quick-reference bullet.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| CONTRIBUTING.md | Adds a dedicated “Using pipe-trait” section with do/don’t guidance and examples. |
| CLAUDE.md | Adds a concise bullet summarizing the pipe-trait guideline. |
| AGENTS.md | Adds the same pipe-trait quick-reference bullet for agents. |
| .github/copilot-instructions.md | Adds the same pipe-trait quick-reference bullet for Copilot instructions. |
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
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.
Added comprehensive documentation for the
pipe-traitcrate usage patterns to the CONTRIBUTING.md file, establishing clear guidelines for when and how to use thePipetrait in the codebase.https://claude.ai/code/session_01DQYEAgJo7PnTgu9ejF1N1p