dialogic-godot / documentation

📖 The documentation for the Dialogic Godot plugin.
http://docs.dialogic.pro
16 stars 12 forks source link

Fix indentation on signal page #35

Closed thiagola92 closed 8 months ago

thiagola92 commented 8 months ago

Context is very clear that everything is signal
> Dialogic subsystems have many useful signals. Here is a selection of them:

coppolaemilio commented 8 months ago

I do prefer that the signal keyword is before each of the signals, same way you add types when doing documentation when describing any token, so I'm not sure about this PR

thiagola92 commented 8 months ago

Changed PR to only fix the spaces because this is the main focus.

same way you add types when doing documentation when describing any token

I'm not sure that I know what you are talking about, maybe an example would help?
My guess is that we declare types in documentation because the reader doesn't know which type will be.
But right here we are listing signals right after something like "hey, this are the signals:".

Not that It's a problem! The important is listing the signals correctly!

coppolaemilio commented 8 months ago

Thanks!

thiagola92 commented 8 months ago

I wasn't reading the documentation from front to back so I didn't notice that this was an issue in many places.

https://dialogic-docs.coppolaemilio.com/variables.html#22-conditions
https://dialogic-docs.coppolaemilio.com/timeline-text-syntax.html#about-special-events
https://dialogic-docs.coppolaemilio.com/creating-extensions.html#7-custom-settings-pages

It seems that #34 replaced some spaces characters with non-breaking space

When editing with VScode you can see a dot where is space
image

I checked with python too
image

That's why the indentation was broken (there was no need to fix using 4 spaces).