Skip to content

Commit

Permalink
Add more repo documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
David Sid Olofsson authored and sidju committed Oct 24, 2023
1 parent fb403d2 commit 2397fb1
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 1 deletion.
11 changes: 11 additions & 0 deletions POTENTIAL_FEATURES.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,14 @@ implement. Further it might be better to keep non-`add-ed` commands more
clearly separate. If you want to use this feature please provide an example
implementation and settle in for some discussion, so the feature is implemented
in a clean way that fits your use-case.

# More variant commands:
There are loads of potential variations on existing commands. I (sidju) have
decided to be restrictive on what I add initially, so that any further built-in
commands can be decided upon through discussion with users later.

Though some variants were added and have implementations ready in the codebase
none of them are enabled, as they were found to not be that useful. Any further
commands will need to be significant distincts (not just prepend to an index
instead of appending, but using start of selection instead of end of selection
is sufficiently distinct if relevant).
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,7 @@ There are two main contributions welcomed as of now.
2. Checking off ToDo:s. Look into the [TODOS.md](TODOS.md) file, pick a task to
do and go wild. You can add a PR to prevent others from working on the same
task (mark it as WIP until relevant to review).
3. Create issues for undocumented or unexpected behaviour.
4. Request support for your use-cases. Create a feature request issue for what
you need. (Look into [POTENTIAL_FEATURES.md](POTENTIAL_FEATURES.md) to see if
a similar feature is prepared and if so note it in the feature request.)
10 changes: 9 additions & 1 deletion RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,11 @@ Nearing a stable release now, so some less clean features are remade in this
release to be easier to maintain in a stable manner forward.

- New command documentation.
- Update the README.md and add more in-repo documentation.
- Add proper macro support under ':', with support for arguments and tests to
verify its behaviour.
verify its behaviour. This also changed the macro methods on `Ed` struct.
- Make '!' forbid selection, instead require using '|' for filtering text
through a shell command.
- Cut down on less meaningful variant commands to make it easier to add more
diverse features without breaking the command language in the future.
- 'J' has been removed, as it is functionally equivalent or inferior to
Expand All @@ -17,6 +20,11 @@ release to be easier to maintain in a stable manner forward.
you might as well just give that index - 1 to prepend.
- Started testing with insight into undo history, so undo snapshot creation is
now testable and verified.
- Made some exported structs impossible to create aside from constructors, to
enable maintaining compability by just keeping the same constructors as the
member variables change.
- Limit nesting depth when running commands than run commands. (Mainly to
prevent macros from doing infinite recursion.)

# 0.10.0
- Add a first sketch of undo/redo. Feedback on behaviour is requested in the
Expand Down

0 comments on commit 2397fb1

Please sign in to comment.