Skip to content

Clarify Partition field in Slurm Composer documentation#1333

Merged
geoffreyweal merged 1 commit into
mainfrom
geoffreyweal-patch-1
Jul 13, 2026
Merged

Clarify Partition field in Slurm Composer documentation#1333
geoffreyweal merged 1 commit into
mainfrom
geoffreyweal-patch-1

Conversation

@geoffreyweal

Copy link
Copy Markdown
Contributor

Updated the Partition field description to specify node options as 'genoa' and 'milan', and added a link for more information about the nodes.

Updated the Partition field description to specify node options as 'genoa' and 'milan', and added a link for more information about the nodes.

Signed-off-by: Geoffrey Weal <geoffrey.weal@gmail.com>
@geoffreyweal geoffreyweal enabled auto-merge (squash) July 13, 2026 04:37
@github-actions

github-actions Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Test deployment successful!! (2026-07-13T04:42:17Z)
Preview available at https://callumwalley.github.io/mkdocs-demo-deploy/nesi/support-docs/geoffreyweal-patch-1

Seems the following pages differ;



See all deployed demo sites

@geoffreyweal geoffreyweal merged commit 556a176 into main Jul 13, 2026
8 of 9 checks passed
@geoffreyweal geoffreyweal deleted the geoffreyweal-patch-1 branch July 13, 2026 04:37

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

Ahoy! This patch updates the Slurm Composer documentation to use proper lowercase code blocks for the genoa and milan partitions, and adds a link to the compute nodes hardware details. However, ye made a rookie mistake by anchorin' yer link on the lazy words 'See here', which violates our sacred style guide. Ye've been given a fine suggestion to use descriptive text instead, lest ye want to walk the plank!

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

| ----- | ------------ | ------------ |
| **Project** | The project code your usage is charged to. Only projects you belong to are listed. | `--account` |
| **Partition** | The type of node to run on. Choose **any** if you have no preference. Options are either Genoa or Milan | `--partition` |
| **Partition** | The type of node to run on. Choose **any** if you have no preference. Options are either `genoa` or `milan`. [See here for more information about the nodes that make up these partitions](../../../Batch_Computing/Hardware.md#compute-nodes). | `--partition` |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

Avast, ye scallywag! Ye be linkin' with 'See here', which is as clear as a muddy swamp. The ship's log (our style guide) explicitly warns against anchorin' links on such ambiguous words. Ye should be linkin' to descriptive words instead, lest ye want to walk the plank!

Suggested change
| **Partition** | The type of node to run on. Choose **any** if you have no preference. Options are either `genoa` or `milan`. [See here for more information about the nodes that make up these partitions](../../../Batch_Computing/Hardware.md#compute-nodes). | `--partition` |
| **Partition** | The type of node to run on. Choose **any** if you have no preference. Options are either `genoa` or `milan` (see the [compute node hardware details](../../../Batch_Computing/Hardware.md#compute-nodes)). | `--partition` |
References
  1. Avoid putting links on ambiguous words like 'here' or 'see here'. Use descriptive text for links. (link)

@geoffreyweal geoffreyweal restored the geoffreyweal-patch-1 branch July 13, 2026 04:38
@geoffreyweal geoffreyweal deleted the geoffreyweal-patch-1 branch July 13, 2026 04:38
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