Compare commits
3 Commits
fixes/load
...
develop
Author | SHA1 | Date | |
---|---|---|---|
![]() |
55fc87cfdc | ||
![]() |
f936bccf7f | ||
78bd091e61 |
@ -7,6 +7,12 @@ A python library to parse, modify and save Org-mode files.
|
|||||||
- Modify these data and write it back to disk.
|
- Modify these data and write it back to disk.
|
||||||
- Keep the original structure intact (indentation, spaces, format, ...).
|
- Keep the original structure intact (indentation, spaces, format, ...).
|
||||||
|
|
||||||
|
** Principles
|
||||||
|
- Avoid any dependency outside of Python's standard library.
|
||||||
|
- Don't do anything outside of the scope of parsing/re-serializing Org-mode files.
|
||||||
|
- *Modification of the original text if there's no change is considered a bug (see [[id:7363ba38-1662-4d3c-9e83-0999824975b7][Known issues]]).*
|
||||||
|
- 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.*
|
||||||
** Safety mechanism
|
** Safety mechanism
|
||||||
As this library is still in early development. Running it over files might
|
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
|
produce unexpected changes on them. For this reason it's heavily recommended to
|
||||||
@ -21,6 +27,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.
|
not properly stored and can trigger this safety mechanism on a false-positive.
|
||||||
|
|
||||||
* Known issues
|
* Known issues
|
||||||
|
:PROPERTIES:
|
||||||
|
:ID: 7363ba38-1662-4d3c-9e83-0999824975b7
|
||||||
|
:END:
|
||||||
** Structure modifications
|
** Structure modifications
|
||||||
:PROPERTIES:
|
:PROPERTIES:
|
||||||
:ID: 76e77f7f-c9e0-4c83-ad2f-39a5a8894a83
|
:ID: 76e77f7f-c9e0-4c83-ad2f-39a5a8894a83
|
||||||
|
@ -1 +0,0 @@
|
|||||||
# No external requirements at this point
|
|
Loading…
Reference in New Issue
Block a user