Slight update to missing strings and resolved algorithm explanation#670
Slight update to missing strings and resolved algorithm explanation#67026oppy wants to merge 5 commits intofreerouting:masterfreerouting/freerouting:masterfrom
Conversation
There was a problem hiding this comment.
Code Review
This pull request adds a comprehensive 'Routing Algorithm' section to the architecture documentation and introduces localization strings for a new selection mode. Review feedback highlights a potential inaccuracy in the documentation regarding multi-threaded optimization, duplicate keys in the properties files, a typo in a tooltip, and a shortcut key conflict between the 'Select' and 'Inspect' buttons.
|
|
||
| - Measure the result. | ||
|
|
||
| The new route is compared with the old one using board metrics such as trace length and via count. In multi-threaded mode, several candidates may be tried and the best one wins. |
There was a problem hiding this comment.
The description of the Optimizer mentions a 'multi-threaded mode' where several candidates are tried. However, the current implementation in BatchOptimizer.java appears to be single-threaded. If multi-threading is not yet implemented or active for the optimizer, this sentence might be misleading for contributors.
| fanout_tooltip=to autoroute the selected SMD pins to the first via | ||
| fanout=Fanout |
There was a problem hiding this comment.
These added lines create duplicate keys in the properties file. fanout=Fanout is already present on line 19, and fanout_tooltip is defined again on line 22. In Java properties files, duplicate keys can lead to unexpected behavior as the last definition typically wins. It seems the intention was to update the existing tooltip rather than append a new one. Please ensure only one definition of each key remains.
fanout_tooltip=to autoroute the selected SMD pins to the first via
| @@ -1,3 +1,5 @@ | ||
| select_button=Select | ||
| select_button_tooltip=left button selects itmes (s) |
There was a problem hiding this comment.
There is a typo in the tooltip text: 'itmes' should be 'items'. Additionally, note that both this button and the 'Inspect' button (line 4) are assigned the same shortcut key '(s)', which will cause a conflict if both are active in the UI.
select_button_tooltip=left button selects items (s)
There was a problem hiding this comment.
Pull request overview
Updates UI localization strings and expands the architecture documentation with a clearer explanation of Freerouting’s routing stages (autorouter vs optimizer), aiming to address missing/old strings and improve developer understanding of the routing flow.
Changes:
- Add missing InteractiveState English strings (select-mode status messages; autorouter pass label).
- Update/extend toolbar English strings (Select button label/tooltip; fanout tooltip wording).
- Add a “Routing Algorithm” section to
docs/architecture.md.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/main/resources/app/freerouting/interactive/InteractiveState_en.properties | Adds missing English interactive-state strings (select mode + autorouter pass label). |
| src/main/resources/app/freerouting/gui/BoardToolbarInspectedItem_en.properties | Updates fanout tooltip text (but currently introduces duplicate keys). |
| src/main/resources/app/freerouting/gui/BoardToolbar_en.properties | Adds missing English “Select” toolbar strings (tooltip has a typo). |
| docs/architecture.md | Documents autorouter vs optimizer stages and their high-level steps. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| fanout_tooltip=to autoroute the selected SMD pins to the first via | ||
| fanout=Fanout |
| @@ -1,3 +1,5 @@ | ||
| select_button=Select | ||
| select_button_tooltip=left button selects itmes (s) |
…g#672 (now closed) This update should improve the selection box such that it doesn't lag around. While ensuring minimal computational needs.
Description
Slight modifications to missing strings
Resolved algorithm explanation.
Issues
Found old fanout strings in code.
I have not gone through all the missing strings yet.