Skip to content

docs: align docstrings and package metadata with VAST product naming#3

Merged
oualib merged 1 commit into
mainfrom
tests-docs-bugfixes-2
Jul 1, 2026
Merged

docs: align docstrings and package metadata with VAST product naming#3
oualib merged 1 commit into
mainfrom
tests-docs-bugfixes-2

Conversation

@oualib

@oualib oualib commented Jul 1, 2026

Copy link
Copy Markdown
Collaborator

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 nameVAST 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).

## 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).
@oualib oualib self-assigned this Jul 1, 2026
@oualib oualib merged commit 1ff8bdd into main Jul 1, 2026
13 checks passed
@oualib oualib added type: docs Documentation only type: refactor Internal change, no behavior change type: test Tests / CI coverage labels Jul 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: docs Documentation only type: refactor Internal change, no behavior change type: test Tests / CI coverage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant