docs: align docstrings and package metadata with VAST product naming#3
Merged
Conversation
## Summary
Aligns docstring and metadata wording with the VAST Data Product Taxonomy &
Naming Style Guide (v1.1) and VAST's public product naming. Documentation and
branding only — no functional, API, or behavioral changes.
## What changed
- **`VAST DataBase`** — standardized the product name, previously written four
inconsistent ways (`VASTDB`, `VAST DB`, `VAST Database`, `VAST database`), to
the correct CamelCase form. Generic, non-product uses of "database" are left
lowercase, per the guide.
- **`scikit-learn`** — replaced all-caps `SKLEARN` in prose with the library's
proper name (import identifiers unchanged).
- **ML model docstrings** — updated the shared boilerplate across
`machine_learning/vast/` ("… using scikit-learn for training and the
scalability of the VAST DataBase for inference"), plus minor grammar (a/an,
serial commas).
- **`Trino`** — corrected prose casing to the proper noun (connection strings
and module references left lowercase).
- **Display name** — `VAST Orbit` used consistently in prose (VAST all-caps per
brand).
- **`pandas`** — lowercased `Pandas` in prose to match the project's own
styling (`DataFrame` kept capitalized as the correct type name).
- **`__description__`** — rewritten for a cleaner, on-brand PyPI summary.
## Not changed (deliberately)
- No renames of the package (`vastorbit`), the repository, or any public
identifiers / classes (`VastFrame`, `VastColumn`, etc.).
- No code logic, signatures, or behavior — the test suite is unaffected.
## Reference
VAST Data Product Taxonomy & Naming Style Guide (v1.1).
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
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
Aligns docstring and metadata wording with the VAST Data Product Taxonomy & Naming Style Guide (v1.1) and VAST's public product naming. Documentation and branding only — no functional, API, or behavioral changes.
What changed
VAST DataBase— standardized the product name, previously written four inconsistent ways (VASTDB,VAST DB,VAST Database,VAST database), to the correct CamelCase form. Generic, non-product uses of "database" are left lowercase, per the guide.scikit-learn— replaced all-capsSKLEARNin prose with the library's proper name (import identifiers unchanged).machine_learning/vast/("… using scikit-learn for training and the scalability of the VAST DataBase for inference"), plus minor grammar (a/an, serial commas).Trino— corrected prose casing to the proper noun (connection strings and module references left lowercase).VAST Orbitused consistently in prose (VAST all-caps per brand).pandas— lowercasedPandasin prose to match the project's own styling (DataFramekept capitalized as the correct type name).__description__— rewritten for a cleaner, on-brand PyPI summary.Not changed (deliberately)
vastorbit), the repository, or any public identifiers / classes (VastFrame,VastColumn, etc.).Reference
VAST Data Product Taxonomy & Naming Style Guide (v1.1).