Skip to content

Improve documentation about Config objects #3779

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

Open
wants to merge 26 commits into
base: master
Choose a base branch
from

Conversation

WardLT
Copy link
Contributor

@WardLT WardLT commented Feb 18, 2025

Description

Dole out content and explanations about Config objects in smaller chunks.

  • Explain the difference between Config, Executor, Provider, and Launcher
  • Give a quick overview of how to select Executor, Provider, and Launcher separate from details
  • Explain which Executor features relate to HTEx or WQEx
  • Move the data stuff to it's own "advanced" section (triaging it for now)
  • Spread out and refine the explanatory text of blocks/parallelism

Changed Behaviour

N/A

Fixes

Part of #3781

Type of change

  • Update to human readable text: Documentation/error messages/comments

@WardLT WardLT marked this pull request as ready for review February 23, 2025 21:46
@WardLT
Copy link
Contributor Author

WardLT commented Feb 24, 2025

I'm realizing that I should mention the other features of a Config object, especially restarting and usage tracking. I'll get at added this week

@WardLT WardLT mentioned this pull request Mar 6, 2025
7 tasks
@WardLT
Copy link
Contributor Author

WardLT commented Mar 6, 2025

Alright, @kylechard or @benclifford , any advice on who I should get to review this?

It does break the "one bullet point per PR" Ben referenced in #3783 . I'm happy to break into small PRs. This was larger than I hoped it to be as breaking off new sections required adding introductory content

@WardLT
Copy link
Contributor Author

WardLT commented Mar 20, 2025

Alright. I made another editing pass after filling in the placeholder for WorkQueue.

Should I recruit someone for reviewing this?

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.

1 participant