Document munging process for `symbol(_)` attributes

Open
#4,025 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Domain
compilers

Research direction

Start by reading docs/kore-syntax.md at the referenced identifier rules and inspecting the affected symbols under k-distribution/includes. Determine whether the intended scope is warnings, a naming convention, cleanup, or all three. Done should include an agreed behavior for invalid symbol attributes and updated nonconforming symbols.

Written by the indexing model from the issue text.

Description

documentation

Characters that are not valid in a KORE identifier (i.e. anything except for digits, letters, - and ') included in the symbol attribute value will be encoded in the corresponding KORE symbol name.

E.g.

symbol(_|->_)

becomes

Lbl'UndsPipe'-'-GT-Unds

in KORE.

In order to ensure that the attribute value (and hence the KLabel of the production) and the KORE symbol are as close to each other as possible (i.e. to make sure the only difference is the Lbl prefix in KORE), consider emitting a warning on such attribute values.

This can be taken one step further by also enforcing a naming convention, e.g. kebab-case (then the symbol would also be a good value for the smtlib attribute, so perhaps we could even drop that one).

A large number of symbols in k-distribution/includes do not conform to this restriction, so those should be cleaned up as well.

Dominant language
Python
Stars
591
Forks
163
PR merge metrics
No merged PRs in 30d

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.

More from runtimeverification/k

All issues in runtimeverification/k

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.