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.

Sign up for GitHub

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

Jump to bottom

Engineer - Readme & Contribution Guidelines - Unify Naming Conventions #7

Closed
stuartjohnpage opened this issue Mar 7, 2024 · 2 comments
Closed

Engineer - Readme & Contribution Guidelines - Unify Naming Conventions #7

stuartjohnpage opened this issue Mar 7, 2024 · 2 comments

Comments

@stuartjohnpage
Copy link
Collaborator

stuartjohnpage commented Mar 7, 2024 •
edited
Loading

Background

Standardize naming conventions both in Text Chunker's readme and codebase

Acceptance Criteria

Scenario: Consistent Naming Convention Across Documentation and Codebase

  • Given there are inconsistencies in naming within the readme and codebase, using both Chunker and TextChunker
  • When documenting and referring to the library in the readme
  • And when instances in the code, such as comments and documentation annotations, reference the library
  • Then ensure all mentions align with a single, consistent naming convention, preferring TextChunker
  • And correct all code comments, documentation strings, and annotations to consistently use TextChunker.

created by stuart.page+prodops1@revelry.co using Prodops
@stuartjohnpage
Copy link
Collaborator Author

looks like this is addressed by #8

@lukeledet
Copy link
Member

merged #8

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@lukeledet @stuartjohnpage