Skip to content

Update job_kwargs shared docs #4058

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.

Sign up for GitHub

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

Jump to bottom
Merged
alejoe91 merged 1 commit into from
Jul 14, 2025
Merged

Update job_kwargs shared docs #4058

alejoe91 merged 1 commit into from
Jul 14, 2025

Conversation

@zm711
Copy link
Member

@zm711 zm711 commented Jul 12, 2025

Fixes #2875

  1. tried to make the n_jobs description more accurate. Please read and add feedback
  2. added in the missing kwargs pool_engine and max_threads_per_worker which were not documented yet.

@zm711 zm711 added documentation Improvements or additions to documentation Harvard Docathon 2025 Related to mini docs based hackathon in Harvard July 2025 labels Jul 12, 2025
chrishalcrow
chrishalcrow approved these changes Jul 12, 2025
View reviewed changes
Copy link
Member

@chrishalcrow chrishalcrow left a comment

Choose a reason for hiding this comment

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

Nice and clear

@alejoe91 alejoe91 added this to the 0.103.0 milestone Jul 14, 2025
@alejoe91
Copy link
Member

alejoe91 commented Jul 14, 2025

beautiful :)

@alejoe91 alejoe91 merged commit a7e51d6 into SpikeInterface:main Jul 14, 2025
15 checks passed
@zm711 zm711 deleted the update-job-kwargs-docs branch July 14, 2025 09:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@h-mayorquin h-mayorquin h-mayorquin approved these changes

@alejoe91 alejoe91 alejoe91 approved these changes

@chrishalcrow chrishalcrow chrishalcrow approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation Harvard Docathon 2025 Related to mini docs based hackathon in Harvard July 2025

Projects

None yet

Milestone

0.103.0

Development

Successfully merging this pull request may close these issues.

Improve docstring explaining job_kwargs

4 participants

@zm711 @alejoe91 @h-mayorquin @chrishalcrow