Skip to content

Comments

Fix: help files use one style#3190

Closed
dustdfg wants to merge 3 commits intomicro-editor:masterfrom
dustdfg:fix/help-one-style
Closed

Fix: help files use one style#3190
dustdfg wants to merge 3 commits intomicro-editor:masterfrom
dustdfg:fix/help-one-style

Conversation

@dustdfg
Copy link
Contributor

@dustdfg dustdfg commented Mar 18, 2024

I also plan:

  1. Use tabs everywhere inside:

    ```json
    ```

  2. Use tabs or spaces before default value: in runtime/help/options.md. Currently there are both types of indents but I think spaces will suit better because tab can have different size

  3. Yeah it is not about help files but about syntax files so I can then rename the PR to "Fix: runtime use one style". So should yaml files use tabs? I vote for tabs

dustdfg added 3 commits March 18, 2024 12:41
Signed-off-by: Yevhen Babiichuk (DustDFG) <dfgdust@gmail.com>
Signed-off-by: Yevhen Babiichuk (DustDFG) <dfgdust@gmail.com>
Signed-off-by: Yevhen Babiichuk (DustDFG) <dfgdust@gmail.com>
color support comes in three flavors.

* 16-color: A colorscheme that uses the 16 default colors will always work but
* `16-color`: A colorscheme that uses the 16 default colors will always work but
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For 16-color, 256-color and true-color the backquotes might be a bit misleading, since these are not "proper names" (option names, terminal names etc)

@dmaluka
Copy link
Collaborator

dmaluka commented Mar 18, 2024

I also plan:

1. Use tabs everywhere inside:
   ```json
   ```

Why?

  1. Use tabs or spaces before default value: in runtime/help/options.md. Currently there are both types of indents but I think spaces will suit better because tab can have different size

I agree, spaces will suit better.

  1. Yeah it is not about help files but about syntax files so I can then rename the PR to "Fix: runtime use one style". So should yaml files use tabs? I vote for tabs

Currently they use spaces. Why change that?

@dmaluka
Copy link
Collaborator

dmaluka commented Mar 18, 2024

Furthermore, apparently YAML doesn't allow indentation with tabs.

This is what happens if I change a space to tab in a syntax file:

$ make
GOOS=linux GOARCH=amd64 go generate ./runtime
panic: yaml: line 7: found character that cannot start any token

goroutine 1 [running]:
main.convert({0xc0000b8f0a, 0x1})
	/home/dmaluka/src/micro/runtime/syntax/make_headers.go:53 +0xc6
main.main()
	/home/dmaluka/src/micro/runtime/syntax/make_headers.go:39 +0xd5
exit status 2
runtime/runtime.go:9: running "go": exit status 1
make: *** [Makefile:38: generate] Error 1

@dustdfg
Copy link
Contributor Author

dustdfg commented Mar 18, 2024

I also plan:

1. Use tabs everywhere inside:
   ```json

Why?

screen-1710768566

Yeah it is solved by another PR...

And there is one file place where json blocks use tabs but in other places it is spaces

@dustdfg dustdfg marked this pull request as ready for review March 18, 2024 16:29
@dustdfg dustdfg marked this pull request as draft March 18, 2024 16:32
@dustdfg
Copy link
Contributor Author

dustdfg commented Mar 18, 2024

One more question. (Only) somewhere in runtime/help/keybindings.md I saw Ctrl-letter use back quotes: Ctrl-e but in other places it is just plain text: Ctrl-e

@dustdfg dustdfg changed the title Fix: help use one style Fix: help files use one style Mar 18, 2024
@dmaluka
Copy link
Collaborator

dmaluka commented Mar 18, 2024

One more question. (Only) somewhere in runtime/help/keybindings.md I saw Ctrl-letter use back quotes: Ctrl-e but in other places it is just plain text: Ctrl-e

Might be worth fixing too. Or maybe it's not really important at all.

@dustdfg
Copy link
Contributor Author

dustdfg commented Mar 18, 2024

Might be worth fixing too. Or maybe it's not really important at all.

At least it grabs attention when opened in the editor but in the online github version it doesn't have much sense

@dustdfg
Copy link
Contributor Author

dustdfg commented Mar 18, 2024

moved to #3193

@dustdfg dustdfg closed this Mar 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants