Skip to content

Commit

Permalink
docs: Update doc comment from normalize function in path plugin t…
Browse files Browse the repository at this point in the history
…o match definition (#8886)

The doc comment from the normalize function in the path plugin was not matching the actual definition.

Rust definition: https://github.com/tauri-apps/tauri/blob/0cb0a15ce22af3d649cf219ac04188c14c5f4905/core/tauri/src/path/plugin.rs#L18

Typescript definition: https://github.com/tauri-apps/tauri/blob/0cb0a15ce22af3d649cf219ac04188c14c5f4905/tooling/api/src/path.ts#L589
  • Loading branch information
marc2332 authored Feb 18, 2024
1 parent 28fb036 commit dbd525c
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion tooling/api/src/path.ts
Original file line number Diff line number Diff line change
Expand Up @@ -581,7 +581,7 @@ async function resolve(...paths: string[]): Promise<string> {
* ```typescript
* import { normalize, appDataDir } from '@tauri-apps/api/path';
* const appDataDirPath = await appDataDir();
* const path = await normalize(appDataDirPath, '..', 'users', 'tauri', 'avatar.png');
* const path = await normalize(`${appDataDirPath}/../users/tauri/avatar.png`);
* ```
*
* @since 1.0.0
Expand Down

0 comments on commit dbd525c

Please sign in to comment.