Document "effective K"

Open
#4,353 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Domain
documentation

Research direction

Start by reviewing the linked compilation-time issue and performance pull request, then gather the existing institutional knowledge about writing K code, including deprecated features and the Kasmer decision tree work. Done means this guidance is consolidated into documentation covering the identified topics.

Written by the indexing model from the issue text.

Description

We currently have a lot of institutional knowledge around the best way to write K code in practice. This covers a lot of different topics:

These should be written up into some kind of documentation so that we don't forget; I spent a bunch of time on the Kasmer decision tree issue that we had actually diagnosed last year.

Dominant language
Python
Stars
591
Forks
163
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.