Skip to content

Docs: Update ID language for RawIO - #1915

Merged
zm711 merged 3 commits into
NeuralEnsemble:masterfrom
zm711:update-docs-ids
Oct 14, 2026
Merged

zm711 merged 3 commits into
NeuralEnsemble:masterfrom
zm711:update-docs-ids

Conversation

@zm711

@zm711 zm711 commented Oct 12, 2026

Copy link
Copy Markdown
Contributor

@h-mayorquin how does this look for tweaking the docs?

@zm711 zm711 added this to the 0.14.6 milestone Oct 12, 2026
@h-mayorquin

Copy link
Copy Markdown
Contributor

I think this is an improvement but maybe we should note that index are ambiguos in the sense that we might change what they address. That is, they are unstable.

@zm711

zm711 commented Oct 13, 2026

Copy link
Copy Markdown
Contributor Author

It's a bit hard for me to figure out the best way to word that. In an individual version of Neo they are stable right? It is just between files/versions that we are drifting a bit? Do you have any ideas for how you want to say it and I can clean up the final language?

@zm711 zm711 mentioned this pull request Oct 13, 2026
@h-mayorquin

Copy link
Copy Markdown
Contributor

If it were up for me I would not mention indices at all. They should be an internal detail of the implementation.

@zm711

zm711 commented Oct 14, 2026

Copy link
Copy Markdown
Contributor Author

Unfortunately they are not currently an internal detail so we have to let users know they exist and are usable.

@h-mayorquin h-mayorquin left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good to me. Small things: "capabilitiies" typo, and the paragraph mixes "ID", "ids" and "IDs". If you want to capture the stability point, maybe something like: "Indices are positional and only stable within a given version of Neo; a reader update (for example adding digital channels) can change which channel an index points to. If your code needs to work across Neo versions, select by ID." Fine either way.

@zm711

zm711 commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor Author

I will add your fixes then merge! Indices is better in my opinion but the argument name is indexes so I'll take that to keep it consistent. Thanks!

Co-Authored-By: Heberto Mayorquin <h.mayorquin@gmail.com>
@zm711
zm711 merged commit 6c555a3 into NeuralEnsemble:master Oct 14, 2026
3 checks passed
@zm711
zm711 deleted the update-docs-ids branch October 14, 2026 14:39
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