Skip to content

Rename proto.py files to types.py #589

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

Closed
2 tasks
rmorshea opened this issue Jan 14, 2022 · 0 comments · Fixed by #701
Closed
2 tasks

Rename proto.py files to types.py #589

rmorshea opened this issue Jan 14, 2022 · 0 comments · Fixed by #701
Labels
priority-3-low May be resolved one any timeline. type-revision About a change in functionality or behavior
Milestone

Comments

@rmorshea
Copy link
Collaborator

Current Situation

In the proto.py files we define both protocols and other useful types. The name "proto" is a bit confusing an could also be confused with protobufs.

Proposed Actions

We should rename these files to types.py in addition we could create top-level idom.types module that exports all these types so that applications can use them to add type annotations more easily.

Work Items

  • rename files to types.py
  • maybe create a top level idom.types module that aggregates useful type definitions
@rmorshea rmorshea added flag-triage Not prioritized. priority-3-low May be resolved one any timeline. labels Jan 14, 2022
@rmorshea rmorshea added this to the 1.0 milestone Jan 14, 2022
@rmorshea rmorshea added type-revision About a change in functionality or behavior and removed flag-triage Not prioritized. labels Jan 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority-3-low May be resolved one any timeline. type-revision About a change in functionality or behavior
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant