Skip to content

docs: standards updates - #216

Merged
jtyoung84 merged 4 commits into
mainfrom
docs-118-standards-updates
Sep 15, 2026
Merged

jtyoung84 merged 4 commits into
mainfrom
docs-118-standards-updates

Conversation

@jtyoung84

@jtyoung84 jtyoung84 commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

Closes https://github.com/AllenNeuralDynamics/aind-scientific-computing/issues/729

  • Clarifies that classes shouldn't be expected to be less than 100 lines
  • Confirms that services need to follow logging standards
  • Updates link to latest template repository

For the first two bullet points in the issue:

  • There is already a link to a detailed documentation about typing (https://peps.python.org/pep-0484)
  • It appears that line about Code should be capable of being analyzed by static analysis tools was removed.

📚 Documentation preview 📚: https://scicomp-docs--216.org.readthedocs.build/en/216/

Comment thread docs/source/policies_practices/software_practices.md Outdated

@arielleleon arielleleon left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

@jtyoung84
jtyoung84 merged commit 3f6a0c8 into main Sep 15, 2026
1 check passed
@jtyoung84
jtyoung84 deleted the docs-118-standards-updates branch September 15, 2026 20:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants