xapi-project / xen-api / 13459274394
79%
master: 80%

LAST BUILD BRANCH: dev/pau/majmin
DEFAULT BRANCH: master
Ran
Jobs 1
Files 38
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 78.516%. Remained the same
13459274394

push

github

web-flow 
Add internal links to XenAPI reference (#6315)

Adds a simple parser for Xapi type expressions that is used to rewrite
the types shown in the XenAPI class reference to include links to
relevant documentation.

---

![image](https://github.com/user-attachments/assets/b1a515b3-6824-4ba8-a925-9989a8cc7270)

---

The parser is structured in the form of a Pratt parser. This may seem
like overkill, but it keeps the door open to extension. Also, the parser
must work with limited information (it has no knowledge of XenAPI object
names). It works by noting that object types are always (?) suffixed by
a type constructor, e.g. `VM ref` - therefore, it assumes any prefix
form must be a valid class name, then subsequent left denotations take
the left as a type parameter (for which all are unary, except `map`
which has an alternative syntax that is special cased).

Currently, the only interesting parts of the "rendered" type are:
- Enum names become links that should scroll and temporarily highlight
(flash) the relevant details.
- Object names become links to their relevant page in the documentation.

However, other structure is retained, such as where builtin (primitive)
types are (e.g. int, bool, string, etc.), constructors names (ref, set,
option, etc.). In future, these could link to relevant portions of a new
article that explains all the types (for example, the format of datetime
is perhaps non-obvious to someone reading the XenAPI reference pages).

3512 of 4473 relevant lines covered (78.52%)

0.79 hits per line

Jobs
ID Job ID Ran Files Coverage
1 python3.11 - 13459274394.1 38
78.52
 GitHub Action Run
Source Files on build 13459274394