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

Fix Cite to honor GAPInfo.TermEncoding for its printing; let BibEntry always use encoding "UTF-8" #4146

Merged
merged 1 commit into from
Oct 30, 2020

Conversation

frankluebeck
Copy link
Member

@frankluebeck frankluebeck commented Oct 19, 2020

BibEntry produces a snippet of XML without processing instruction
about its encoding. Therefore the result should be in the default
encoding "UTF-8" for our XML parser.

Instead Cite should use the setting in GAPInfo.TermEncoding for
its printing.

Before this fix Cite ran into an error in a terminal with, say, latin1 encoding.
The fix was tested in terminals with utf8 and with latin1 encoding. I don't see how to add a test for this in the tst directory.

Description

see above

Text for release notes

not needed

@frankluebeck frankluebeck added the kind: bug: unexpected error Issues describing bugs in which computation unexpectedly encounters an error, and PRs fixing them label Oct 19, 2020
@coveralls
Copy link

coveralls commented Oct 19, 2020

Coverage Status

Coverage remained the same at 93.725% when pulling eeac3b4 on frankluebeck:fl_fixencodingBibEntry into e0a20c3 on gap-system:master.

lib/package.gi Outdated Show resolved Hide resolved
Copy link
Contributor

@ThomasBreuer ThomasBreuer left a comment

Choose a reason for hiding this comment

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

Very good.
(I have inserted one comment concerning an old typo which could be fixed now.)

lib/package.gi Outdated Show resolved Hide resolved
@ThomasBreuer ThomasBreuer added release notes: not needed PRs introducing changes that are wholly irrelevant to the release notes topic: library labels Oct 21, 2020
`BibEntry` produces a snippet of XML without processing instruction
about its encoding. Therefore the result should be in the default
encoding "UTF-8" for our XML parser.

Instead `Cite` should use the setting in GAPInfo.TermEncoding for
its printing.

This commit also improves some details in the code of `Cite`:
  - indentation of code
  - normalized spelling of package names
  - fix of typo
@frankluebeck
Copy link
Member Author

I have added a comment, fixed the typo as suggested, and added a remark to the commit message.

@fingolfin fingolfin added release notes: to be added PRs introducing changes that should be (but have not yet been) mentioned in the release notes kind: enhancement Label for issues suggesting enhancements; and for pull requests implementing enhancements and removed release notes: not needed PRs introducing changes that are wholly irrelevant to the release notes labels Oct 21, 2020
Copy link
Member

@fingolfin fingolfin left a comment

Choose a reason for hiding this comment

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

Thanks!

@fingolfin fingolfin merged commit ca6a301 into gap-system:master Oct 30, 2020
@ThomasBreuer ThomasBreuer changed the title Fix encoding of BibEntry(nam) and Cite Fixed Cite w.r.t. the encoding used; let BibEntry always use encoding "UTF-8". Feb 16, 2021
@ThomasBreuer ThomasBreuer added release notes: added PRs introducing changes that have since been mentioned in the release notes and removed release notes: to be added PRs introducing changes that should be (but have not yet been) mentioned in the release notes labels Feb 16, 2021
@fingolfin fingolfin changed the title Fixed Cite w.r.t. the encoding used; let BibEntry always use encoding "UTF-8". Fix Cite to honor GAPInfo.TermEncoding for its prining; let BibEntry always use encoding "UTF-8" Aug 17, 2022
@fingolfin fingolfin changed the title Fix Cite to honor GAPInfo.TermEncoding for its prining; let BibEntry always use encoding "UTF-8" Fix Cite to honor GAPInfo.TermEncoding for its printing; let BibEntry always use encoding "UTF-8" Aug 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: bug: unexpected error Issues describing bugs in which computation unexpectedly encounters an error, and PRs fixing them kind: enhancement Label for issues suggesting enhancements; and for pull requests implementing enhancements release notes: added PRs introducing changes that have since been mentioned in the release notes topic: library
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants