Skip to content

Replace `<stuff>' with '<stuff>' #4875

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

Conversation

owen-mc-diffblue
Copy link
Contributor

This changes the error message from
failed to load class `java.nio.file.Path'
to
failed to load class 'java.nio.file.Path'

  • Each commit message has a non-empty body, explaining why the change was made.
  • Methods or procedures I have added are documented, following the guidelines provided in CODING_STANDARD.md.
  • The feature or user visible behaviour I have added or modified has been documented in the User Guide in doc/cprover-manual/
  • Regression or unit tests are included, or existing tests cover the modified code (in this case I have detailed which ones those are in the commit message).
  • My commit message includes data points confirming performance improvements (if claimed).
  • My PR is restricted to a single feature or bugfix.
  • White-space or formatting changes outside the feature-related changed lines are in commits of their own.

@owen-mc-diffblue owen-mc-diffblue changed the title Replace backtick with single quote Replace backtick with single quote in error message Jul 4, 2019
@danpoe
Copy link
Contributor

danpoe commented Jul 4, 2019

That's probably intentional as the pattern with left hand ` and right hand ' occurs more frequently in the code than two single quotes.

@owen-mc-diffblue
Copy link
Contributor Author

owen-mc-diffblue commented Jul 6, 2019

Thanks for pointing that out @danpoe , on closer inspection I see that you are right. In that case, I'm expanding the scope of this PR to replace ` with ' everywhere where the closing delimiter is '. I think this is a much more common usage of punctuation.

@owen-mc-diffblue owen-mc-diffblue changed the title Replace backtick with single quote in error message Replace `<stuff>' with '<stuff>' Jul 6, 2019
@tautschnig
Copy link
Collaborator

@owen-jones-diffblue Why is this a desirable change?

@kroening
Copy link
Member

kroening commented Jul 7, 2019

This is certainly a very unimportant point one could get very excited about.
https://www.cl.cam.ac.uk/~mgk25/ucs/quotes.html
We could add quotebegin and quoteend stream modifiers. The result could then be quotes, a change in font, etc., depending on target.

@owen-mc-diffblue
Copy link
Contributor Author

@tautschnig As the link that @kroening posted says, the convention of quoting `text like this' looks odd in most modern fonts.

I appreciate this is not a majorly important change, but it's something that annoys me. I think it makes the output look unprofessional. It was a treat I gave myself after doing some very tedious work I didn't really want to do. The prompt was someone asking about an error message, and they obviously thought it was a mistake that there was a ` instead of a '.

@tautschnig
Copy link
Collaborator

@owen-jones-diffblue Thank you for elaborating - it would be really helpful to have the "Why?" answered in commit messages (always, not just here). That settled, we are probably very inconsistent about our quoting and thus this is a really good step forward! My only reservation is that there may be users parsing warnings and thus we'd (negatively) surprise them, but arguably no one should rely on formatting of plain-text messages so I'm ok to ignore this one.

@owen-mc-diffblue owen-mc-diffblue force-pushed the owen/replace-backtick-with-single-quote branch 5 times, most recently from 10878d2 to db75f0c Compare July 8, 2019 15:33
@codecov-io
Copy link

Codecov Report

Merging #4875 into develop will decrease coverage by <.01%.
The diff coverage is 17.27%.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #4875      +/-   ##
===========================================
- Coverage    69.09%   69.09%   -0.01%     
===========================================
  Files         1298     1298              
  Lines       106944   106951       +7     
===========================================
  Hits         73895    73895              
- Misses       33049    33056       +7
Impacted Files Coverage Δ
src/goto-programs/goto_convert.cpp 91.18% <ø> (ø) ⬆️
src/langapi/mode.cpp 100% <ø> (ø) ⬆️
src/goto-symex/symex_function_call.cpp 87.23% <ø> (ø) ⬆️
src/analyses/goto_check.cpp 78.99% <ø> (ø) ⬆️
src/cbmc/cbmc_parse_options.cpp 76.47% <ø> (ø) ⬆️
src/cpp/cpp_typecheck_bases.cpp 62.68% <ø> (ø) ⬆️
jbmc/src/janalyzer/janalyzer_parse_options.cpp 45.7% <ø> (ø) ⬆️
src/goto-analyzer/show_on_source.cpp 95.45% <ø> (ø) ⬆️
src/solvers/smt2/smt2_conv.cpp 60.01% <ø> (ø) ⬆️
src/util/config.cpp 56.02% <ø> (ø) ⬆️
... and 79 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7051df5...db75f0c. Read the comment docs.

tautschnig added a commit to tautschnig/cbmc that referenced this pull request Oct 20, 2022
These will permit custom formatting of quoting for each message handler,
See diffblue#4875 for discussion.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Oct 20, 2022
This continues the work of diffblue#4875, but now using quote_begin/quote_end
stream modifiers.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Oct 20, 2022
This is in the spirit of diffblue#4875, but now using quote_begin/quote_end stream
modifiers.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Oct 20, 2022
These will permit custom formatting of quoting for each message handler,
See diffblue#4875 for discussion.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Oct 20, 2022
This continues the work of diffblue#4875, but now using quote_begin/quote_end
stream modifiers.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Oct 20, 2022
This is in the spirit of diffblue#4875, but now using quote_begin/quote_end stream
modifiers.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Oct 27, 2022
These will permit custom formatting of quoting for each message handler,
See diffblue#4875 for discussion.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Oct 27, 2022
This continues the work of diffblue#4875, but now using quote_begin/quote_end
stream modifiers.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Oct 27, 2022
This is in the spirit of diffblue#4875, but now using quote_begin/quote_end stream
modifiers.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Oct 27, 2022
These will permit custom formatting of quoting for each message handler,
See diffblue#4875 for discussion.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Oct 27, 2022
This continues the work of diffblue#4875, but now using quote_begin/quote_end
stream modifiers.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Oct 27, 2022
This is in the spirit of diffblue#4875, but now using quote_begin/quote_end stream
modifiers.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Nov 4, 2022
These will permit custom formatting of quoting for each message handler,
See diffblue#4875 for discussion.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Nov 4, 2022
This continues the work of diffblue#4875, but now using quote_begin/quote_end
stream modifiers.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Nov 4, 2022
This is in the spirit of diffblue#4875, but now using quote_begin/quote_end stream
modifiers.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Nov 20, 2022
These will permit custom formatting of quoting for each message handler,
See diffblue#4875 for discussion.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Nov 20, 2022
This continues the work of diffblue#4875, but now using quote_begin/quote_end
stream modifiers.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Nov 20, 2022
This is in the spirit of diffblue#4875, but now using quote_begin/quote_end stream
modifiers.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Feb 23, 2023
These will permit custom formatting of quoting for each message handler,
See diffblue#4875 for discussion.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Feb 23, 2023
This continues the work of diffblue#4875, but now using quote_begin/quote_end
stream modifiers.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Feb 23, 2023
This is in the spirit of diffblue#4875, but now using quote_begin/quote_end stream
modifiers.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Feb 23, 2023
This continues the work of diffblue#4875, but now using quote_begin/quote_end
stream modifiers.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Feb 23, 2023
This is in the spirit of diffblue#4875, but now using quote_begin/quote_end stream
modifiers.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Jun 1, 2023
These will permit custom formatting of quoting for each message handler,
See diffblue#4875 for discussion.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Jun 1, 2023
This continues the work of diffblue#4875, but now using quote_begin/quote_end
stream modifiers.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Jun 1, 2023
This is in the spirit of diffblue#4875, but now using quote_begin/quote_end stream
modifiers.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Jun 1, 2023
This is in the spirit of diffblue#4875, but now using quote_begin/quote_end stream
modifiers.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Apr 26, 2024
These will permit custom formatting of quoting for each message handler,
See diffblue#4875 for discussion.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Apr 26, 2024
This continues the work of diffblue#4875, but now using quote_begin/quote_end
stream modifiers.
tautschnig added a commit to tautschnig/cbmc that referenced this pull request Apr 26, 2024
This is in the spirit of diffblue#4875, but now using quote_begin/quote_end stream
modifiers.
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.