Skip to content

Commit

Permalink
Doxumentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
James Smith authored and James Smith committed Nov 18, 2024
1 parent 952c086 commit 68447af
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ The AnsiString and AnsiStr classes contains the following `__init__` method.
def __init__(self, s:str='', *setting_or_settings:Union[List[str], str, List[int], int, List[AnsiFormat], AnsiFormat]): ...
```

The first argument, `s`, is a string to be formatted. The next 0 to N arguments are formatting setting directives that can be applied to the entire string. These arguments can be in the form of any of the following.
The first argument, `s`, is a string to be formatted. If this string contains ANSI directives, they will be parsed and added into the internal format dictionary. The next 0 to N arguments are formatting setting directives that can be applied to the entire string. These arguments can be in the form of any of the following.

- An AnsiFormat enum (ex: `AnsiFormat.BOLD`)
- The result of calling `AnsiFormat.rgb()`, `AnsiFormat.fg_rgb()`, `AnsiFormat.bg_rgb()`,
Expand Down
2 changes: 1 addition & 1 deletion src/ansi_string/ansi_string.py
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ def __init__(
'''
Creates an AnsiString
Parameters:
s - The underlying string or an AnsiString to copy from
s - The underlying string or an AnsiString to copy from; incoming strings will be parsed for ANSI directives
settings - setting(s) in any of the listed formats below
- An AnsiFormat enum (ex: `AnsiFormat.BOLD`)
- The result of calling `AnsiFormat.rgb()`, `AnsiFormat.fg_rgb()`, `AnsiFormat.bg_rgb()`,
Expand Down

0 comments on commit 68447af

Please sign in to comment.