Conversation
- Rename verbose public API functions to concise verb-first names:\n * embed_corpus_submit_openai_batch() -> batch_submit_openai()\n * embed_corpus_status_openai_batch() -> batch_status_openai()\n * embed_corpus_collect_openai_batch() -> batch_collect_openai()\n * finalize_demo_openai_batch() -> demo_finalize_openai_batch()\n * run_demo_openai_quarto() -> run_demo_openai()\n * run_demo_openalex_quarto() -> run_demo_openalex()\n * embedding_backend_config()/info()/embed_texts()/read()/save()\n -> backend_config()/backend_info()/backend_embed_texts()/backend_read()/backend_save()\n- Rename R source files to match new API/module vocabulary:\n * embed_backend_* -> backend_*\n * embed_corpus_*_openai_batch -> batch_*_openai\n * embed_corpus_openai_batch_helpers.R -> batch_openai_helpers.R\n * embed_openai_batch_helper.R -> batch_openai_http.R\n * run_demos.R -> demo_run.R\n- Update all internal call sites, tests, demo templates, and vignettes to new names.\n- Regenerate roxygen outputs (NAMESPACE + man pages): remove old Rd files and add new ones for renamed exports.\n- Update NEWS with breaking-change migration table (old -> new API).\n- Bump package/documentation version references to 0.3.0 in:\n * DESCRIPTION\n * README\n * NEWS\n * IMPLEMENTATION_NOTES\n * DEVELOPMENT_CONTINUITY\n\nNotes:\n- This is an immediate breaking rename with no compatibility wrappers, per release plan assumptions.\n- Behavior/signatures remain otherwise unchanged beyond function/file names.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR now reflects the v0.3.0 release scope on
devand includes a broad API/file rename plus documentation/version synchronization.Major changes
Renamed verbose exported API to concise verb-first names (breaking change, no wrappers):
embed_corpus_submit_openai_batch()->batch_submit_openai()embed_corpus_status_openai_batch()->batch_status_openai()embed_corpus_collect_openai_batch()->batch_collect_openai()finalize_demo_openai_batch()->demo_finalize_openai_batch()run_demo_openai_quarto()->run_demo_openai()run_demo_openalex_quarto()->run_demo_openalex()embedding_backend_config()->backend_config()embedding_backend_info()->backend_info()embedding_backend_embed_texts()->backend_embed_texts()embedding_backend_read()->backend_read()embedding_backend_save()->backend_save()Renamed
R/source files to match the new API/module vocabulary:embed_backend_*->backend_*embed_corpus_*_openai_batch->batch_*_openaiembed_corpus_openai_batch_helpers.R->batch_openai_helpers.Rembed_openai_batch_helper.R->batch_openai_http.Rrun_demos.R->demo_run.RUpdated internal call sites, tests, vignettes, demo templates, and README to new names.
Regenerated roxygen outputs (
NAMESPACE,man/*) for renamed exports.Split release vs continuity docs:
NEWS.mdas user-facing changelogDEVELOPMENT_CONTINUITY.md)IMPLEMENTATION_NOTES.mdas engineering/release logVersion sync to 0.3.0 across:
DESCRIPTION,README.md,NEWS.md,IMPLEMENTATION_NOTES.md,DEVELOPMENT_CONTINUITY.mdBreaking Changes
Validation
devtools::document()devtools::test()R CMD check --no-manual --no-examples --no-tests .Notes
devmain