Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

XML links and references must be a full word #323

Open
jonnew opened this issue Oct 5, 2024 · 0 comments
Open

XML links and references must be a full word #323

jonnew opened this issue Oct 5, 2024 · 0 comments
Assignees
Milestone

Comments

@jonnew
Copy link
Member

jonnew commented Oct 5, 2024

For example, in the description of NeuropixelsV1Data the following XML comment is used

/// Produces a sequence of <see cref="NeuropixelsV1eDataFrame"/>s from a NeuropixelsV1e headstage.

The link <see cref="NeuropixelsV1eDataFrame"/>s results in:

image

Instead, the following should be used

<see cref="NeuropixelsV1eDataFrame">NeuropixelsV1eDataFrames</see> so the "s" becomes part of the link. This pattern should be repeated in all similar situations.

@jonnew jonnew added this to the 0.5.0 milestone Oct 15, 2024
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

No branches or pull requests

2 participants