<commit_before>Pathname
========
OOP wrapper for `fs`, `path` and `Stat` functions.

This document describes the api. See README.md for overview and usage.

* Pathnames are immutable

Core Node Functions
-------------------


Pathname-specific Methods
-------------------------
Pathname also provides a few extra methods, which can be quite useful.

### toString()
String representation of `path` object

    new Pathname('/tmp/foo').toString()
    #=> '/tmp/foo'

### parent()
Parent directory of `path`

    new Pathname('/tmp/foo').parent().toString()
    #=> '/tmp'

### children()
All paths (files and directories) one level below `path` in the fs tree. `path`
must be a directory.

    # given: '/tmp/foo', '/tmp/bar'

    new Pathname('/tmp').children()
    #=> [Pathname('/tmp/foo'), Pathname('/tmp/bar')]

### siblings()
All paths (files and directories) in the same directory level as `path`,
excluding `path`<commit_msg>Updates api doc<commit_after>PATHNAME
========
OOP wrapper for `fs`, `path` and `Stat` functions. This document describes the api. See README.md for overview and usage.


CORE NODE FUNCTIONS
-------------------
Pathnames are immutable


PATHNAME-SPECIFIC METHODS
-------------------------
Pathname also provides a few extra methods, which can be quite useful.

### toString()
String representation of `path` object

    new Pathname('/tmp/foo').toString()
    #=> '/tmp/foo'

### parent()
Parent directory of `path`

    new Pathname('/tmp/foo').parent()
    #=> Pathname('/tmp') #i.e. Pathname object for path '/tmp'

### children()
All paths (files and directories) one level below `path` in the fs tree. `path`
must be a directory.

    # given: '/tmp/foo', '/tmp/bar'

    new Pathname('/tmp').children()
    #=> [Pathname('/tmp/foo'), Pathname('/tmp/bar')]

### siblings()
All paths (files and directories) in the same directory level as `path`,
excluding `path`
{'fraction_non_alphanumeric': 0.1917808219178082, 'fraction_numerical': 0.0, 'mean_word_length': 3.19205298013245, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 9, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5474056', 'n_tokens_mistral': 561, 'n_tokens_neox': 537, 'n_words': 203}