Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document convenience methods on Edge: apply, pipe and run #40

Closed
ptomecek opened this issue Feb 7, 2024 · 1 comment
Closed

Document convenience methods on Edge: apply, pipe and run #40

ptomecek opened this issue Feb 7, 2024 · 1 comment
Assignees
Labels
part: documentation Improvements/bugs/changes to documentation

Comments

@ptomecek
Copy link
Collaborator

ptomecek commented Feb 7, 2024

The documentation should make users aware of the following convenience methods on Edge: apply, pipe and run, with some simple examples of how they can be leveraged to simplify the syntax or work with csp more easily.

apply: https://github.com/Point72/csp/blob/main/csp/impl/wiring/edge.py#L136
pipe: https://github.com/Point72/csp/blob/main/csp/impl/wiring/edge.py#L157
run: https://github.com/Point72/csp/blob/main/csp/impl/wiring/edge.py#L173

@ptomecek
Copy link
Collaborator Author

Added a new section on Edge methods to https://github.com/Point72/csp/wiki/1.-Generic-Nodes-(csp.baselib)
Happy to move it if needed. The other most suitable place for it seemed to be the Introduction.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
part: documentation Improvements/bugs/changes to documentation
Projects
None yet
Development

No branches or pull requests

2 participants