Skip to content

Conversation

@somebody1234
Copy link
Contributor

@somebody1234 somebody1234 commented Mar 25, 2025

Pull Request Description

  • Remove ====== section headers from Dashboard codebase

Important Notes

Let me know if some comments should be preserved as doc-style comments. This is a quick-and-dirty refactor using find-and-replace with the empty string. Search string used in VS Code included below for posterity.


(// =+)
// ===.+
\1

Note that the trailing and leading newline are important.

Checklist

Please ensure that the following checklist has been satisfied before submitting the PR:

  • The documentation has been updated, if necessary.
  • Screenshots/screencasts have been attached, if there are any visual changes. For interactive or animated visual changes, a screencast is preferred.
  • All code follows the
    Scala,
    Java,
    TypeScript,
    and
    Rust
    style guides. In case you are using a language not listed above, follow the Rust style guide.
  • Unit tests have been written where possible.
  • If meaningful changes were made to logic or tests affecting Enso Cloud integration in the libraries,
    or the Snowflake database integration, a run of the Extra Tests has been scheduled.
    • If applicable, it is suggested to paste a link to a successful run of the Extra Tests.

@somebody1234 somebody1234 added CI: No changelog needed Do not require a changelog entry for this PR. x-chore Type: chore g-electron GUI: electron application specific g-dashboard -gui labels Mar 25, 2025
@github-actions
Copy link

github-actions bot commented Mar 25, 2025

🧪 Storybook is successfully deployed!

📊 Dashboard:

@vitvakatu
Copy link
Contributor

What is the reasoning here? I think in a lot of cases these comments help navigate big source files.

@MrFlashAccount
Copy link
Contributor

Even though these comments are obsolete for Dashboard code (we prefer smaller files), I’m certain we need to discuss this with the project-view team first. Alternatively, we can scope this PR to only touch dashboard-related code.

@somebody1234
Copy link
Contributor Author

yeah i think in project view they're used better, in the dashboard most files are on the smaller side so they're often used to annotate the single export

Copy link
Contributor

@farmaazon farmaazon left a comment

Choose a reason for hiding this comment

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

Yes, please spare headers in project-view files.

BTW, these are not particularly "rust specific", these are just our headers. Scala files have similar.

@somebody1234 somebody1234 force-pushed the wip/sb/remove-rust-style-comments branch from 0e4ee3d to b776e7d Compare March 25, 2025 14:48
@somebody1234 somebody1234 requested a review from farmaazon March 25, 2025 14:48
@somebody1234 somebody1234 changed the title Remove Rust-style section headers Remove ===== style section headers Mar 25, 2025
@somebody1234 somebody1234 changed the title Remove ===== style section headers Remove ===== style section headers from Dashboard Mar 25, 2025
@somebody1234
Copy link
Contributor Author

pinging @MrFlashAccount for CR.

QA should not be needed because there are no code changes

@somebody1234 somebody1234 added the CI: Ready to merge This PR is eligible for automatic merge label Mar 25, 2025
@mergify mergify bot merged commit a0fbbf7 into develop Mar 25, 2025
60 of 61 checks passed
@mergify mergify bot deleted the wip/sb/remove-rust-style-comments branch March 25, 2025 19:40
@jdunkerley jdunkerley added this to the 2025-Q1 Release milestone Mar 26, 2025
farmaazon pushed a commit that referenced this pull request Mar 26, 2025
- Remove `======` section headers from Dashboard codebase

# Important Notes
Let me know if some comments should be preserved as doc-style comments. This is a quick-and-dirty refactor using find-and-replace with the empty string. Search string used in VS Code included below for posterity.

```

(// =+)
// ===.+
\1

```

Note that the trailing and leading newline are important.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

-gui CI: No changelog needed Do not require a changelog entry for this PR. CI: Ready to merge This PR is eligible for automatic merge g-dashboard g-electron GUI: electron application specific x-chore Type: chore

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants