compas-dev / compas-dev/compas

Add some diagrams to compas.geometry documentation

Open
#895 1 comment 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
Python
Stars
386
Forks
122
Avg merge
11d 46m
Merged PRs (30d)
1

Description

# Feature Request

As a [user], I want [to understand how geometry primitives are parametrized] so that [I don't have to trail and error].

## Details

**Is your feature request related to a problem? Please describe.**
I was trying to understand if `compas.geometry.Cylinder` is defined with a circle at the middle of the cylinder (extruding to both sides of the circle) or at the base of the cylinder.

**Describe the solution you'd like**
I would like a simple diagram so I can understand it immediately.

**Describe alternatives you've considered**
Trail and error / Looking into the implementation is time consumming.

**Additional context**
For illustrative purposes of what I mean by diagram, I found the following image on Google.
![cylinder parameters](https://user-images.githubusercontent.com/1297653/132331028-fff8d327-7a74-4c74-b62b-9cae265ba978.gif)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.