COVESA / COVESA/ifex

Verify examples integrity/correctness against internal model

Open
#102 0 comments 0 reactions 0 assignees View on GitHub
quality
Dominant language
Python
Stars
24
Forks
24
PR merge metrics
No merged PRs in 30d

Description

Examples are written both in the static text of the specification, and in the written in the text strings that make up documentation for each of the item types in the internal model (this text also gets copied into the spec during the generation of docs from the model).

It would be _really nice_(tm) if examples were somehow extracted and formally verified to be correct according to the model. The design of this is however very TBD. Open for suggestions.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the specification's static examples, the item-type documentation strings in the internal model, and the documentation-generation path. Compare how examples are represented in each source and determine a verification design. Done means the examples can be extracted and formally checked for correctness against the model.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.