Files
modeling-app/docs/kcl-std/functions/std-units-toYards.md
2025-06-19 17:08:46 +12:00

29 lines
553 B
Markdown

---
title: "units::toYards"
subtitle: "Function in std::units"
excerpt: "Converts a number to yards from its current units."
layout: manual
---
Converts a number to yards from its current units.
### Arguments
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `num` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
### Returns
[`number(yd)`](/docs/kcl-std/types/std-types-number) - A number.
### Function signature
```kcl
units::toYards(@num: number(Length)): number(yd)
```