CadQuery / CadQuery/cadquery

Make/Fix "API references" into hyperlinks to the API docs?

Open
#444 1 comment 0 reactions 0 assignees View on GitHub
docs
Dominant language
Python
Stars
5.8k
Forks
541
Avg merge
3d 2h
Merged PRs (30d)
5

Description

A cadquery newbee here. Decided to learn. I am following documentation and got to
https://cadquery.readthedocs.io/en/latest/examples.html#simple-rectangular-plate

At the end of the example there are

```
Workplane() ! | Workplane.box() !
```

those aren't hyperlinks to bring me to API docs (e.g. https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.box for `Workplane.box`). ~~Not sure what `!s` are about -- annotating errors of linking? doesn't look like since next example has `Workplane.box()` (twice!) without any `!` . Confused.~~

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.