Conversation
|
This was just a test for the action |
There was a problem hiding this comment.
Pull request overview
Renames the BBOB suite entry to BBOB_test and updates the published documentation tables to reflect the new name.
Changes:
- Renamed the first suite entry in
problems.yamlfromBBOBtoBBOB_test. - Updated the corresponding suite name shown in
docs/index.htmlanddocs/problems.html. - Adjusted some rendered HTML table cells (e.g.,
None→ empty, and whitespace changes).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 10 comments.
| File | Description |
|---|---|
| problems.yaml | Renames the BBOB suite entry to BBOB_test. |
| docs/problems.html | Updates the rendered problems table entry and includes additional output-format changes. |
| docs/index.html | Updates the rendered index table entry and includes additional output-format changes. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| <tr> | ||
| <td>TulipaEnergy</td> | ||
| <td>Determine the optimal investment and operation decisions for different types of assets in the energy system (production, consumption, conversion, storage, and transport), while minimizing loss of load.</td> | ||
| <td>Determine the optimal investment and operation decisions for different types of assets in the energy system (production, consumption, conversion, storage, and transport), while minimizing loss of load.</td> |
There was a problem hiding this comment.
Replacing plain whitespace with makes the rendered content harder to maintain and can affect line wrapping/responsiveness. If the goal is to remove an accidental double-space in the source text, it’s better to fix the underlying YAML text (or normalize whitespace during HTML generation) and regenerate the docs, rather than embedding non-breaking spaces in the HTML output.
| <td>Determine the optimal investment and operation decisions for different types of assets in the energy system (production, consumption, conversion, storage, and transport), while minimizing loss of load.</td> | |
| <td>Determine the optimal investment and operation decisions for different types of assets in the energy system (production, consumption, conversion, storage, and transport), while minimizing loss of load.</td> |
| <td>artificial</td> | ||
| <td><a href="https://doi.org/10.1145/3449726.3459521">https://doi.org/10.1145/3449726.3459521</a></td> | ||
| <td>None</td> | ||
| <td></td> |
There was a problem hiding this comment.
Same generated-output concern here: prefer addressing missing-value rendering in yaml_to_html.py (or in problems.yaml) and regenerating, rather than patching individual HTML table cells.
| <tr> | ||
| <td>TulipaEnergy</td> | ||
| <td>Determine the optimal investment and operation decisions for different types of assets in the energy system (production, consumption, conversion, storage, and transport), while minimizing loss of load.</td> | ||
| <td>Determine the optimal investment and operation decisions for different types of assets in the energy system (production, consumption, conversion, storage, and transport), while minimizing loss of load.</td> |
There was a problem hiding this comment.
Embedding in the generated table content makes the docs harder to maintain and can cause non-wrapping whitespace in narrow views. Prefer fixing the underlying YAML text (remove accidental double spaces) or normalizing whitespace in yaml_to_html.py, then regenerate docs/index.html.
| <td>Determine the optimal investment and operation decisions for different types of assets in the energy system (production, consumption, conversion, storage, and transport), while minimizing loss of load.</td> | |
| <td>Determine the optimal investment and operation decisions for different types of assets in the energy system (production, consumption, conversion, storage, and transport), while minimizing loss of load.</td> |
| <td>artificial</td> | ||
| <td><a href="https://doi.org/10.1145/3449726.3459521">https://doi.org/10.1145/3449726.3459521</a></td> | ||
| <td>None</td> | ||
| <td></td> |
There was a problem hiding this comment.
The HTML docs in docs/ are generated from problems.yaml via yaml_to_html.py. This PR changes the rendered output beyond the stated rename (e.g., removing literal None display), but the generator script isn’t updated here; these manual edits are likely to drift or be overwritten next time yaml_to_html.py is run. Consider fixing this at the source by adjusting yaml_to_html.py to render missing values consistently (e.g., normalize None/NA to empty strings) and then regenerate/commit the HTML outputs.
| <td>artificial</td> | ||
| <td><a href="https://doi.org/10.1145/3449726.3459521">https://doi.org/10.1145/3449726.3459521</a></td> | ||
| <td>None</td> | ||
| <td></td> |
There was a problem hiding this comment.
As with docs/problems.html, docs/index.html is produced by yaml_to_html.py. These None→empty edits appear to be output-level changes not explained by the PR’s stated goal; updating the generator/YAML and regenerating will keep the docs deterministic and avoid future reintroductions.
| <td></td> | |
| <td>None</td> |
| <td>artificial</td> | ||
| <td><a href="https://doi.org/10.1145/3449726.3459521">https://doi.org/10.1145/3449726.3459521</a></td> | ||
| <td>None</td> | ||
| <td></td> |
There was a problem hiding this comment.
Same issue as the other None→empty changes: if the docs are intended to be regenerated, manual edits here will likely be lost. Updating the generator/YAML and regenerating will keep the output consistent.
| @@ -1,4 +1,4 @@ | |||
| - name: BBOB | |||
| - name: BBOB_test | |||
There was a problem hiding this comment.
BBOB_test is the only suite/problem name in problems.yaml that uses an underscore; other names consistently use hyphens or spaces. If this is intended to be a public-facing identifier, consider renaming to match the established naming pattern (e.g., BBOB-test or BBOB (test)) to avoid an inconsistent entry and potential downstream parsing/slug issues.
| - name: BBOB_test | |
| - name: BBOB-test |
| @@ -1,4 +1,4 @@ | |||
| - name: BBOB | |||
| - name: BBOB_test | |||
There was a problem hiding this comment.
PR title suggests only a rename in problems.yaml, but this PR also changes generated documentation HTML (including unrelated whitespace/missing-value rendering). Consider updating the PR title/description to reflect the full scope, or splitting the docs-regeneration/formatting changes into a separate commit/PR for easier review.
| <td>artificial</td> | ||
| <td><a href="https://doi.org/10.1145/3449726.3459521">https://doi.org/10.1145/3449726.3459521</a></td> | ||
| <td>None</td> | ||
| <td></td> |
There was a problem hiding this comment.
Same as above: this None→empty change looks like a generated-output difference rather than a source change. To keep docs/problems.html reproducible, update yaml_to_html.py (or the YAML data) and regenerate instead of patching individual cells in the HTML.
| <td>artificial</td> | ||
| <td><a href="https://doi.org/10.1145/3449726.3459521">https://doi.org/10.1145/3449726.3459521</a></td> | ||
| <td>None</td> | ||
| <td></td> |
There was a problem hiding this comment.
Same issue here: editing generated HTML cell content directly is brittle. Prefer to update the YAML source (e.g., make the field truly empty) or update yaml_to_html.py to handle missing values, then regenerate the docs.
No description provided.