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

Rename the fields in ResumeClassifierBlockState #251

Open
V0ldek opened this issue Sep 7, 2023 · 1 comment
Open

Rename the fields in ResumeClassifierBlockState #251

V0ldek opened this issue Sep 7, 2023 · 1 comment
Labels
acceptance: go ahead Reviewed, implementation can start area: library Improvements to the library API quality good first issue Good for newcomers help wanted External contributions welcome type: reliability Tests, code quality
Milestone

Comments

@V0ldek
Copy link
Member

V0ldek commented Sep 7, 2023

Is your feature request related to a problem? Please describe.
I just had to write this line of code:

block.block.block[block.idx] == b'"'

I think it's self explanatory. In more details, this stems from a couple of things.

  1. We often use a variable representing either a QuoteClassifiedBlock or the ResumeClassifierBlockState as block (or b).
  2. ResumeClassifierBlockState has the field that holds the QuoteClassifiedBlock and it's called block.
  3. And that struct has a field holding the actual input block called block.

Describe the solution you'd like
Anything sensible here. My initial hunch is:

  1. Rename such variables to block_state or resume_state or classifier_state.
  2. Rename the first field to quote_classified or quote_classification.
  3. As an alternative, leave that field as block but rename the one on QuoteClassifiedBlock to source.
@V0ldek V0ldek added the type: reliability Tests, code quality label Sep 7, 2023
@github-actions github-actions bot added the acceptance: triage Waiting for owner's input label Sep 7, 2023
@github-actions
Copy link

github-actions bot commented Sep 7, 2023

Tagging @V0ldek for notifications

@V0ldek V0ldek added this to the v1.0.0 milestone Sep 7, 2023
@github-actions github-actions bot added acceptance: go ahead Reviewed, implementation can start and removed acceptance: triage Waiting for owner's input labels Sep 7, 2023
@V0ldek V0ldek added help wanted External contributions welcome good first issue Good for newcomers mod: engine area: library Improvements to the library API quality labels Sep 7, 2023
@V0ldek V0ldek assigned V0ldek and unassigned V0ldek Sep 29, 2023
@V0ldek V0ldek modified the milestones: v1.0.0, lib v1.0.0 Nov 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
acceptance: go ahead Reviewed, implementation can start area: library Improvements to the library API quality good first issue Good for newcomers help wanted External contributions welcome type: reliability Tests, code quality
Projects
Development

No branches or pull requests

1 participant