Skip to content

[DOC] Improve trial_shifting parameter documentation#704

Open
CozySocksAlways wants to merge 1 commit into
NeuralEnsemble:masterfrom
INM-6:fix/trial_shift_doc
Open

[DOC] Improve trial_shifting parameter documentation#704
CozySocksAlways wants to merge 1 commit into
NeuralEnsemble:masterfrom
INM-6:fix/trial_shift_doc

Conversation

@CozySocksAlways

Copy link
Copy Markdown
Contributor

Desc

Extended trial_shifting dither param doc to mention direction of dither

@CozySocksAlways CozySocksAlways added this to the v1.3.0 milestone Jun 17, 2026
@CozySocksAlways CozySocksAlways added the documentation Indicates a need for improvements or additions to documentation label Jun 17, 2026
@CozySocksAlways CozySocksAlways marked this pull request as ready for review June 17, 2026 14:08
@CozySocksAlways CozySocksAlways requested a review from kohlerca June 17, 2026 14:08
@coveralls

Copy link
Copy Markdown
Collaborator

Coverage Status

coverage: 88.592% (-0.01%) from 88.605% — INM-6:fix/trial_shift_doc into NeuralEnsemble:master

dither : pq.Quantity
Amount of dithering.
Amount of dithering. Each trial is shifted by a random amount
uniformly drawn from the range `(-dither, +dither)`.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Update to closed interval ([]), also update implementation to use random.uniform().

For the text: "All spikes in a trial are shifted ..."

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Indicates a need for improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants