|
|
I wrote in this comment on issue #135:
The docs in chapter "Designing a Simple Text Editor" show in paragraph "Syntax Highlighting" much code including the entire style_parse() function. This code has obviously not been updated regularly, there are some parts missing/incomplete/outdated.
... we should synchronize the code and the docs at some time. I'm also not sure if it's useful to add the entire new functionality to the editor demo. Maybe it would be a compromise to
- do only a small fix but not to update the entire code or
- remove the function from the docs and refer to the real code in the source distro and
- fix the syntax highlighting code by adding separate files/functions that can be shared with fluid
or something like that. In the simplest case we'd just document that the documentation is incomplete and that the real code in the source distro should be consulted (to avoid too much code duplication in the docs).
[End of citation].
The mentioned "new functionality" refers to the new style_parse() function in a separate file in fluid.
I'm opening this issue and classifying it as "Documentation" as a reminder that this should be done. It's low priority but since the editor code is documented it should be synchronized in one way or the other.
— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or unsubscribe.
[ Direct Link to Message ] | |
|
| |