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

function renames etc #8

Open
14 tasks
naturallymitchell opened this issue Jan 31, 2019 · 2 comments
Open
14 tasks

function renames etc #8

naturallymitchell opened this issue Jan 31, 2019 · 2 comments

Comments

@naturallymitchell
Copy link
Member

naturallymitchell commented Jan 31, 2019

reviews appreciated

  • base: models-setup, stores-setup
  • get_validator -> document-check-model
  • validate_document -> document-check-model
  • add_document_to_index -> index-document
  • documents -> store-documents
  • get_document_path -> document-get-path
  • query -> index-documents
  • read_document -> document-read
  • read_log -> logdocument-read
  • setup_index -> index-setup
  • setup_schema -> schema-setup
  • split-header -> document-parse
  • walk-documents -> documents-walk
  • write-file -> document-write
@sh-zam
Copy link
Collaborator

sh-zam commented Jan 31, 2019

We could change write_file to write_document
Other than that, I think the original names are good.
It would be better of we could use short hand for common ones like get_doc_path

@naturallymitchell
Copy link
Member Author

I want to start each function name with what gets acted on (the 'target' of the operation).
and end with the 'act' (the verb).
so document-write instead of write-document.
please make comments and preferably changes to issue summary to finalize this plan and swiftly finish one pass

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

2 participants