chacha/pysimpleini
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 55 Wiki Activity

update documentation

Browse Source
This commit is contained in:
cclecle
2023-04-01 01:19:22 +01:00
parent 34f6f5f3f8
commit ca514d5358
4 changed files with 8 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -10,9 +10,6 @@
# pySimpleINI # pySimpleINI
_A simple ini parser / factory_ _A simple but powerfull ini parser / factory_
Checkout [Latest Documentation](https://chacha.ddns.net/mkdocs-web/chacha/pysimpleini/master/latest/). Checkout [Latest Documentation](https://chacha.ddns.net/mkdocs-web/chacha/pysimpleini/master/latest/).
## Features
## Options

2
docs-static/usage.md
View File

@@ -193,7 +193,7 @@ myini.filepath = "somedir/somefile.ini"
myini.writefile() myini.writefile()
``` ```
__Read the API documentation and the unit test for more informations __ __Read the API documentation and the unit test for more informations.__
## limitations ## limitations

8
src/pysimpleini/sections.py
View File

@@ -60,12 +60,12 @@ class SectionBase(metaclass=ABCMeta):
"""Output the full formated Section's. """Output the full formated Section's.
Example: Example:
''' ```console
[Section Name] [Section Name]
Key1Name = Key1Value Key1Name = Key1Value
Key2Name = Key2Value Key2Name = Key2Value
... ...
''' ```
Args: Args:
bBeautify: enable space around '=' bBeautify: enable space around '='
@@ -153,12 +153,12 @@ class Section(SectionComment, SectionBlanck):
"""Output the full formated Section's. """Output the full formated Section's.
Example: Example:
''' ```
[Section Name] [Section Name]
Key1Name = Key1Value Key1Name = Key1Value
Key2Name = Key2Value Key2Name = Key2Value
... ...
''' ```
Args: Args:
bBeautify: enable space around '=' bBeautify: enable space around '='

2
src/pysimpleini/simpleini.py
View File

@@ -11,7 +11,7 @@
"""Main PySimpleINI module. """Main PySimpleINI module.
///note ///note
Contain all the core code. Contain the first level user accessible methods.
/// ///
""" """