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

doc: fix jobs field in config #7381

Merged
merged 2 commits into from
Mar 22, 2023

Conversation

Alizter
Copy link
Collaborator

@Alizter Alizter commented Mar 22, 2023

In #6392 we introduce the config options into the main doc. There was a typo where the jobs stanza was written as concurrency. Here we fix that.

@emillon could you get this fix into the stable version of the docs?

I only noticed this after some users were confused about it.

Signed-off-by: Ali Caglayan <[email protected]>
@Alizter Alizter requested a review from christinerose as a code owner March 22, 2023 19:05
Copy link
Collaborator

@nojb nojb left a comment

Choose a reason for hiding this comment

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

I would suggest changing the variable concurrency to jobs in

and+ concurrency = field_o "jobs" (1, 0) Concurrency.decode

(and to propagate that renaming everywhere else)

@Alizter Alizter added the docs Documentation improvements label Mar 22, 2023
@Alizter
Copy link
Collaborator Author

Alizter commented Mar 22, 2023

@nojb I think that can be an independent change, if we want to do it, though I am not sure it is a good idea.

@Alizter Alizter merged commit ddf85a8 into ocaml:main Mar 22, 2023
@Alizter Alizter deleted the ps/branch/doc__fix_jobs_field_in_config branch March 22, 2023 22:21
@emillon
Copy link
Collaborator

emillon commented Mar 23, 2023

@emillon could you get this fix into the stable version of the docs?

This can be backported to 3.7.x like any other change, let's discuss if there are other candidates.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants