Skip to content

Rename BBOB to BBOB_test in problems.yaml#162

Closed
CIGbalance wants to merge 2 commits intomainfrom
test/html_action
Closed

Rename BBOB to BBOB_test in problems.yaml#162
CIGbalance wants to merge 2 commits intomainfrom
test/html_action

Conversation

@CIGbalance
Copy link
Copy Markdown
Collaborator

No description provided.

Copilot AI review requested due to automatic review settings April 21, 2026 10:23
@CIGbalance
Copy link
Copy Markdown
Collaborator Author

This was just a test for the action

@CIGbalance CIGbalance closed this Apr 21, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.yaml from BBOB to BBOB_test.
  • Updated the corresponding suite name shown in docs/index.html and docs/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.

Comment thread docs/problems.html
<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&nbsp;&nbsp;for different types of assets in the energy system (production, consumption, conversion, storage, and transport), while minimizing loss of load.</td>
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

Replacing plain whitespace with &nbsp;&nbsp; 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.

Suggested change
<td>Determine the optimal investment and operation decisions&nbsp;&nbsp;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>

Copilot uses AI. Check for mistakes.
Comment thread docs/index.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>
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

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.

Copilot uses AI. Check for mistakes.
Comment thread docs/index.html
<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&nbsp;&nbsp;for different types of assets in the energy system (production, consumption, conversion, storage, and transport), while minimizing loss of load.</td>
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

Embedding &nbsp;&nbsp; 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.

Suggested change
<td>Determine the optimal investment and operation decisions&nbsp;&nbsp;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>

Copilot uses AI. Check for mistakes.
Comment thread docs/problems.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>
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

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.

Copilot uses AI. Check for mistakes.
Comment thread docs/index.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>
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
<td></td>
<td>None</td>

Copilot uses AI. Check for mistakes.
Comment thread docs/index.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>
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

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.

Copilot uses AI. Check for mistakes.
Comment thread problems.yaml
@@ -1,4 +1,4 @@
- name: BBOB
- name: BBOB_test
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
- name: BBOB_test
- name: BBOB-test

Copilot uses AI. Check for mistakes.
Comment thread problems.yaml
@@ -1,4 +1,4 @@
- name: BBOB
- name: BBOB_test
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

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.

Copilot uses AI. Check for mistakes.
Comment thread docs/problems.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>
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

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.

Copilot uses AI. Check for mistakes.
Comment thread docs/problems.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>
Copy link

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

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

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.

Copilot uses AI. Check for mistakes.
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.

2 participants