Picture of the author
docs(brainglobe-space): standardize import alias in examples
brainglobe/brainglobe.github.ioGitHub
Merged 4 months agoAugust 7, 2025
Related#344

Standardized the import alias for the brainglobe_space library from bg to bgs in documentation code examples.

What was done

  • Updated the import alias for brainglobe_space from bg to bgs in all Python code examples.
  • Standardized the alias used for the brainglobe_space library across the documentation.
  • Modified code examples in the brainglobe-space documentation page.

Impact

  • Improves developer experience by providing a consistent alias in documentation examples.
  • Enhances readability and maintainability of the documentation.
  • No functional changes to the brainglobe_space library or its functionality.

Technical details

  • The file docs/source/documentation/brainglobe-space/index.md was modified.
  • Changes involved simple text replacement within Python code blocks.
  • This was a documentation consistency update.

Metadata