evhub / evhub/coconut

Add documentation for in-place backward pipes

Open
#855 2 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
4.4k
Forks
142
PR merge metrics
No merged PRs in 30d

Description

The in-place backwards pipe operators are a little confusing to me, so I was wondering if other newcomers would benefit from some additional documentation on them.

* an example of how you might use these operators could help aid in understanding
* how the operators are written might be made explicit, at least I found myself wondering whether it was `<|=` or `=<|` (though I quickly figured it out, and the second form wouldn't match any of the other in-place operators in coconut/python anyway)
* It might be helpful to list out all the in-place versions, since I think some of them are not mentioned in the documentation at all.

Counterpoint, perhaps if these are infrequently used, adding detailed information on them would be confusing to newcomers. But the language documentation describes itself as a reference/specification, so I think it makes sense to include them.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.