lyz/org-rw
1
0
Fork 0
forked from kenkeiras/org-rw
Code Pull Requests 1 Actions Activity

doc: Add a small "Principles" section to README.

Browse Source
This commit is contained in:
Sergio Martínez Portela 2025-04-16 00:46:52 +02:00
parent 78bd091e61
commit f936bccf7f
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.org
View File

@ -7,6 +7,10 @@ A python library to parse, modify and save Org-mode files.
- Modify these data and write it back to disk.
- Keep the original structure intact (indentation, spaces, format, ...).
** Principles
- Data structures should be exposed as it's read on Emacs's org-mode or when in doubt as raw as possible.
- Data in the objects should be modificable, as a way to update the document itself. *Consider this a Object-oriented design.*
- *Modification of the original text if there's no change is considered a bug (see [[id:7363ba38-1662-4d3c-9e83-0999824975b7][Known issues]]).*
** Safety mechanism
As this library is still in early development. Running it over files might
produce unexpected changes on them. For this reason it's heavily recommended to
@ -21,6 +25,9 @@ Also, see [[id:76e77f7f-c9e0-4c83-ad2f-39a5a8894a83][Known issues:Structure modi
not properly stored and can trigger this safety mechanism on a false-positive.
* Known issues
:PROPERTIES:
:ID: 7363ba38-1662-4d3c-9e83-0999824975b7
:END:
** Structure modifications
:PROPERTIES:
:ID: 76e77f7f-c9e0-4c83-ad2f-39a5a8894a83