Feature: Clickable hyperlinks in 'Report View' and 'Python Console' (Step 1 for making friendlier error messages)

Have some feature requests, feedback, cool stuff to share, or want to know where FreeCAD is going? This is the place.
Forum rules
Be nice to others! Read the FreeCAD code of conduct!
Post Reply
User avatar
Kunda1
Veteran
Posts: 13434
Joined: Thu Jan 05, 2017 9:03 pm

Feature: Clickable hyperlinks in 'Report View' and 'Python Console' (Step 1 for making friendlier error messages)

Post by Kunda1 »

This is a feature request:

Report_view and Python console output errors that could be a lot more user friendly, i.e we could link the user to a webpage that could give them some background about said error.

Example:
Source code locations of an ambiguous error that we could help the end user out with a little more context.
Source code locations of an ambiguous error that we could help the end user out with a little more context.
8wS6Qg0w.jpg medium.jpg (155.51 KiB) Viewed 1057 times
The first step would be to make hyperlinks clickable in both dialog boxes.
Alone you go faster. Together we go farther
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs
User avatar
Kunda1
Veteran
Posts: 13434
Joined: Thu Jan 05, 2017 9:03 pm

Re: Feature: Clickable hyperlinks in 'Report View' and 'Python Console' (Step 1 for making friendlier error messages)

Post by Kunda1 »

CCing folks that maybe interested in this feature implementation
Alone you go faster. Together we go farther
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs
TheMarkster
Veteran
Posts: 5505
Joined: Thu Apr 05, 2018 1:53 am

Re: Feature: Clickable hyperlinks in 'Report View' and 'Python Console' (Step 1 for making friendlier error messages)

Post by TheMarkster »

Here is a link to a discussion about making links editable in a QTextEdit.

https://stackoverflow.com/questions/358 ... -qtextedit
User avatar
Kunda1
Veteran
Posts: 13434
Joined: Thu Jan 05, 2017 9:03 pm

Re: Feature: Clickable hyperlinks in 'Report View' and 'Python Console' (Step 1 for making friendlier error messages)

Post by Kunda1 »

The idea is to locate relevant warnings in the source: https://github.com/FreeCAD/FreeCAD/sear ... 29.Warning
and then make sure they link to their relevant help page.
Alone you go faster. Together we go farther
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs
User avatar
onekk
Veteran
Posts: 6149
Joined: Sat Jan 17, 2015 7:48 am
Contact:

Re: Feature: Clickable hyperlinks in 'Report View' and 'Python Console' (Step 1 for making friendlier error messages)

Post by onekk »

Or maybe parsing output of error message or modify the string in between.

Anither idea: Errors should be centralized in a place maybe so the function is not outputting the string directly but invoking something like

Code: Select all

RaiseError("OCCT234")
the method could do many things, among others:

A proper formatting
Translation
Beautify with links


Regards

Carlo D.
GitHub page: https://github.com/onekk/freecad-doc.
- In deep articles on FreeCAD.
- Learning how to model with scripting.
- Various other stuffs.

Blog: https://okkmkblog.wordpress.com/
Post Reply