typst / typst/codex

Suggestion: include Unicode codepoint standard names to sym.txt

Open
#6 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

  • #9 by @emilyyyylime — closed without merging
meta
Dominant language
Rust
Stars
53
Forks
22
PR merge metrics
No merged PRs in 30d

Description

Many symbols in sym.txt are specified as their Unicode codepoint in the form U+XXXX rather than a plain character, because it would be hard to parse or notice when reading the file later. I believe using the Unicode-assigned name of such characters would be more useful and self-documenting than simply entering the code point.

Ideally, these names would be machine-checked in build.rs rather than just act as informative comments, to ease the minds of reviewers from ensuring the right name is provided for each character. These names could also then be used to look up the wanted Unicode codepoint thereby entirely replacing the U+ scalar reference.

Either way, we could opt to include the names even on characters that are directly embedded in the txt files just to have more context directly available when editing them (though this is definitely more of a bonus/personal preference change and should be discussed separately.)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with src/modules/sym.txt and build.rs to understand how Unicode symbols and codepoint references are represented and checked. Review the discussion and closed pull request #9 before narrowing the scope. Done should mean the agreed naming approach is consistently represented and machine-checked without ambiguity.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
build-system, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.