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

Missing yo-doc for some zefops #38

Open
ageron opened this issue Jan 27, 2023 · 2 comments
Open

Missing yo-doc for some zefops #38

ageron opened this issue Jan 27, 2023 · 2 comments

Comments

@ageron
Copy link
Contributor

ageron commented Jan 27, 2023

The following zefops have no yo documentation:

  • yo(L)
  • yo(allow_tombstone)
  • yo(expect)
  • yo(collect)
  • yo(func)
@zeyadkhaled
Copy link
Member

  • L is a relic from old traversal styles and should be removed altogether if there are no dependencies on it anymore.

  • allow_tombstone and expect were both throwing an exception when yo was called on them, that has been fixed now, but they will remain for the time being without a docstring as they don't have any implementations but are used as flags, I think these should be revisited and changed to ValueTypes as they don't have any implementations. Would you agree @pengwyn?

  • Both collect and func had an ugly repr and that has been fixed now. As for showing a docstring, it would be tricky as they aren't exactly a ZefOp. But it is something I can play around with at some point.

@pengwyn
Copy link
Collaborator

pengwyn commented Jan 27, 2023

I agree with making those allow_tombstone and expect turned into ValueTypes. Although expect I don't think has been used yet, so we might have to rejig that for a different purpose later on.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants