Skip to content

Commit

Permalink
fixing docs typos and grammar changes
Browse files Browse the repository at this point in the history
  • Loading branch information
santisq committed Mar 23, 2023
1 parent 95b0694 commit 7aade55
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Compatible with __Windows PowerShell v5.1__ and __PowerShell 7+__.

## Usage

### Get the hierarchy of the current Directory with default parameters values
### Get the current directory hierarchy with default parameters values

```powershell
PS ..\PSTree> Get-PSTree
Expand Down Expand Up @@ -134,7 +134,7 @@ d---- │ │ │ └── en 5.5 Kb
d---- │ │ ├── WindowsErrorReporting 7.4 Kb
```

### Display folders only 2 levels deep
### Recurse subdirectories only 2 levels in Depth

```powershell
PS ..\PSTree> $tree = Get-PSTree C:\Windows\System32\ -Directory -Depth 2 -EA 0
Expand Down
12 changes: 6 additions & 6 deletions docs/en-US/Get-PSTree.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Get-PSTree [[-LiteralPath] <String>] [-Recurse] [-Force] [-Directory] [-Recursiv

## EXAMPLES

### Example 1: Get the hierarchy of the current directory with default parameter values
### Example 1: Get the current directory hierarchy with default parameter values

```powershell
PS C:\> Get-PSTree
Expand All @@ -47,19 +47,19 @@ The default parameter set uses `-Depth` with a value of 3. No hidden and system
PS C:\> Get-PSTree $HOME -Directory -Recurse
```

### Example 3: Get hierarchy of the `$HOME` directory 2 levels deep displaying hidden files and folders
### Example 3: Recurse `$HOME` subdirectories 2 levels in depth displaying hidden files and folders

```powershell
PS C:\> Get-PSTree -Depth 2 -Force
```

### Example 4: Get the hierarchy of the `C:\` drive 2 levels deep displaying only folders with their recursive size
### Example 4: Recurse the `C:\` drive 2 levels in depth displaying only folders with their recursive size

```powershell
PS C:\> Get-PSTree C:\ -Depth 2 -RecursiveSize -Directory
```

### Example 5: Get the hierarchy of the `$HOME` directory recursively excluding all `.jpg` and `.png` files
### Example 5: Get the `$HOME` directory hierarchy recursively excluding all `.jpg` and `.png` files

```powershell
PS C:\> Get-PSTree $HOME -Recurse -Exclude *.jpg, *.png
Expand Down Expand Up @@ -172,9 +172,9 @@ Accept wildcard characters: False

This switch enables the cmdlet to calculate the recursive size of folders in a hierarchy.
By default, the cmdlet only displays the size of folders based on the sum of the file's Length in each directory.
It's important to note that this is a more expensive operation, in order to calculate the recursive size, all folders in the hierarchy need to be traversed.
It's important to note that this is a more expensive operation, in order to calculate the recursive size, all items in the hierarchy needs to be traversed.

By default, the size of hidden and system items is not added to the recursive size of the folders, for this you must use the `-Force` parameter. Excluded files and folders with the `-Exclude` parameter do not add to the recursive folders size.
By default, the size of hidden and system items is not added to the recursive size, for this you must use the `-Force` parameter. Excluded items with the `-Exclude` parameter do not add to the recursive size.

```yaml
Type: SwitchParameter
Expand Down

0 comments on commit 7aade55

Please sign in to comment.