Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature request: remove the 'Dialect used:' line from default output #6

Closed
dogweather opened this issue Apr 9, 2019 · 3 comments
Closed
Labels
enhancement New feature or request

Comments

@dogweather
Copy link

dogweather commented Apr 9, 2019

Describe the feature you'd like to see added.
In the spirit of this project, the most important information is shown first. Currently, the Dialect used: output is fairly high up, before the human-readable description. In the common case, it says "None", which can imply that this is the user's error. But It's essentially debug info, not adding relevant info for the person who's wondering why they have an error. I.e., the "dialect" doesn't relate to their error. It's an avantpy implementation detail.

I propose that we don't show it at all. And only show it in response to a 'verbose' or 'show configs' option.

Who would benefit most from this?
This would mostly benefit:

  • students learning programming
  • teachers/tutors helping student

Is this something you would like to contribute
Sure, I could contribute this.

Context

From the blog post, AvantPy Needs You:

Screen Shot 2019-04-09 at 2 01 50 PM

@dogweather dogweather added the enhancement New feature or request label Apr 9, 2019
@dogweather dogweather changed the title Feature request: remove the 'dialect' line from default output Feature request: remove the 'Dialect used:' line from default output Apr 9, 2019
@aroberge
Copy link
Owner

aroberge commented Apr 9, 2019

This makes a lot of sense!

Note that I just (temporarily) stopped working on AvantPy, as I decided that "friendlier" tracebacks would be potentially more useful in a large number of settings. So, two days ago, I created a new project (code: https://github.com/aroberge/friendly-traceback) focusing on that aspect. As you can imagine, not that much can be done in two days, and the code definitely needs to be reorganized for that new project - something I plan to do this week.

Given your keen eye and good sense of what should be shown, you might be interested in having a look at the "design" document (https://aroberge.github.io/friendly-traceback/docs/html/design.html) for friendly-traceback and perhaps give your thoughts on it.

Meanwhile, if you want to change the way the information is displayed for AvantPy, by all means, feel free to do so; I will gladly incorporate such changes. However, if you prefer to wait until friendly-traceback is a bit more mature, and can be used in conjunction with AvantPy, that would be fine too.

@dogweather
Copy link
Author

dogweather commented Apr 10, 2019

Thank you! I'll read the design docs.

By the way, I landed at this repo via a link from this blog post, which I landed at in turn, from "Friendly Tracebacks" posted to Pycoder's Weekly, Issue 363.

So maybe a link to the new repo on the blog post would help steer the incoming people there.

@aroberge
Copy link
Owner

Thanks, both for your interest in reading the design docs, and suggesting I update my blog following Pycoder's Weekly mentioning it.
I'm keeping this issue open and will remove the mention of dialect myself later if you do not do it, which you can do of course.- it should be very straightforward to do, and will require me to update the French translation as well after it is done.

aroberge added a commit that referenced this issue May 7, 2019
@aroberge aroberge closed this as completed May 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants