Skip to content

Conversation

@h-mayorquin
Copy link
Contributor

No change in behavior, just detailed documentation of the data layout on the format plus the output format of the DAC converter protocols output.

@h-mayorquin h-mayorquin self-assigned this Oct 21, 2025
Copy link
Contributor

@zm711 zm711 left a comment

Choose a reason for hiding this comment

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

I guess we haven't formally discussed Numpy doc-esque standards as a rule. I like all the info you're providing, but I think we should include a rationale in the PR explaining why you want these new headers (vs the standard Parameters, Returns, Examples, Notes). Traditionally a lot of this type of description has gone at the top of files in a large docstring.

@h-mayorquin
Copy link
Contributor Author

I guess we haven't formally discussed Numpy doc-esque standards as a rule. I like all the info you're providing, but I think we should include a rationale in the PR explaining why you want these new headers (vs the standard Parameters, Returns, Examples, Notes). Traditionally a lot of this type of description has gone at the top of files in a large docstring.

Do we have any preference for the format (numpy vs google docs)?

Two things:

  1. I want an explanation of the data layout on disk
  2. I prefer to have the information close to where it is used.

This is the rationale. Does any other format where this is done differently comes to mind? so we can contrast strategies.

@h-mayorquin h-mayorquin merged commit fd0ac2b into NeuralEnsemble:master Dec 4, 2025
3 checks passed
@h-mayorquin
Copy link
Contributor Author

@zm711 I am gonna merge this, I would be happy to discuss docstring conventions and help you refactor them to move in that direction if you want to discuss this further.

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.

3 participants