modeling-app/docs/kcl-std/functions/std-units-toYards.md

---
title: "units::toYards"
subtitle: "Function in units"
excerpt: "Converts a number to yards from its current units."
layout: manual
---

Converts a number to yards from its current units.

```kcl
units::toYards(@num: number(yd)): number(yd)
```


### Arguments

| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `num` | `number(yd)` |  | Yes |

### Returns

`number(yd)`
Turn on units of measure (BREAKING CHANGE) (#6343) * Turn on uom checks Signed-off-by: Nick Cameron <nrc@ncameron.org> * Convert all lengths to mm for engine calls Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org> 2025-04-23 10:58:35 +12:00			`---`
Add subtitle to docs and fix primitive type links (#6724) Signed-off-by: Nick Cameron <nrc@ncameron.org> 2025-05-07 10:33:23 +12:00			`title: "units::toYards"`
			`subtitle: "Function in units"`
Turn on units of measure (BREAKING CHANGE) (#6343) * Turn on uom checks Signed-off-by: Nick Cameron <nrc@ncameron.org> * Convert all lengths to mm for engine calls Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org> 2025-04-23 10:58:35 +12:00			`excerpt: "Converts a number to yards from its current units."`
			`layout: manual`
			`---`

			`Converts a number to yards from its current units.`

Some improvements to the boxed signatures in the docs (#6593) * Show a more reasonable name in function docs Signed-off-by: Nick Cameron <nrc@ncameron.org> * Fix buggy docs for union types Signed-off-by: Nick Cameron <nrc@ncameron.org> * Make types in the docs signatures into links Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org> 2025-05-01 04:03:22 +12:00			```kcl
Docs improvements (#6615) Signed-off-by: Nick Cameron <nrc@ncameron.org> 2025-05-02 03:56:27 +12:00			`units::toYards(@num: number(yd)): number(yd)`
Turn on units of measure (BREAKING CHANGE) (#6343) * Turn on uom checks Signed-off-by: Nick Cameron <nrc@ncameron.org> * Convert all lengths to mm for engine calls Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org> 2025-04-23 10:58:35 +12:00			```

Add subtitle to docs and fix primitive type links (#6724) Signed-off-by: Nick Cameron <nrc@ncameron.org> 2025-05-07 10:33:23 +12:00

Turn on units of measure (BREAKING CHANGE) (#6343) * Turn on uom checks Signed-off-by: Nick Cameron <nrc@ncameron.org> * Convert all lengths to mm for engine calls Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org> 2025-04-23 10:58:35 +12:00			`### Arguments`

			`\| Name \| Type \| Description \| Required \|`
			`\|----------\|------\|-------------\|----------\|`
			\| `num` \| `number(yd)` \| \| Yes \|

			`### Returns`

			`number(yd)`