function renames etc
naturallymitchell opened this issue · comments
Mitchell Tannenbaum commented
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 commented
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
Mitchell Tannenbaum commented
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