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

The distinction between trace event and protocol event can be confusing for newcomers #74

Open
TWal opened this issue Oct 14, 2024 · 2 comments
Labels
cleanup Ideas to make the code cleaner documentation Improvements or additions to documentation

Comments

@TWal
Copy link
Collaborator

TWal commented Oct 14, 2024

Mentioned by @qaphla in #73 (review)

@TWal TWal added documentation Improvements or additions to documentation cleanup Ideas to make the code cleaner labels Oct 14, 2024
@cwaldm
Copy link
Contributor

cwaldm commented Oct 15, 2024

How about renaming the trace events to "trace_entry"?
Then we have the intuitive

  • trace = rev_list trace_entry
  • get_entry_at (instead of get_event_at)
  • entry_exists
    ...

@TWal
Copy link
Collaborator Author

TWal commented Oct 15, 2024

I think that would be fine!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup Ideas to make the code cleaner documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants