nitx: use doc commands #2591
Merged
nitx: use doc commands #2591
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
privat
reviewed
Nov 29, 2017
src/doc/templates/templates_term.nit
Outdated
|
|
||
| redef class MEntity | ||
|
|
||
| # ASCII icon to be displayed in front of the entity |
src/doc/templates/templates_term.nit
Outdated
| i += 1 | ||
| var line = fr.read_line | ||
| if i < location.line_start or i > location.line_end then continue | ||
| # FIXME add nitlight for console |
There was a problem hiding this comment.
console nitlight might be a good idea.
src/doc/templates/templates_term.nit
Outdated
| fun cs_source_code: String do | ||
| var file = location.file | ||
| if file == null then return "" | ||
| var fr = new FileReader.open(file.filename) |
There was a problem hiding this comment.
the source in in the location. why not ask for it? Location::text
|
|
||
| redef class MDoc | ||
| # Returns the full comment formatted for the console | ||
| fun cs_comment(no_color: nullable Bool, indent: nullable Int): String do |
There was a problem hiding this comment.
a lot of your function have a no_color parameter. I'm worrying that someday you may want to add more options/flag.
What about having a single config parameter where you can add more flags/option, and even delegate some services?
There was a problem hiding this comment.
Let's refactor it when needed.
| for line in content do | ||
| res.append "{" " * indent}{line}\n" | ||
| end | ||
| if no_color == null or not no_color then |
There was a problem hiding this comment.
alternative nullable bool patterns are:
if no_color == true thenbut is weird because the nullness is not explicit and that makes the test looks like a truismif no_color or else true thenis nice because we do not repeat theno_colorand the behavior of the null case is explicit, but aor elsein aifmight be confusing to some
There was a problem hiding this comment.
I used all three alternatives in different projects. I still not sure of my favorite.
So I left it as it is.
src/doc/templates/templates_term.nit
Outdated
| if not mparameters.is_empty then | ||
| tpl.append "(" | ||
| for i in [0..mparameters.length[ do | ||
| tpl.append mparameters[i].cs_signature |
privat
approved these changes
Nov 29, 2017
Morriar
force-pushed
the
nitx-commands
branch
from
c45768c
to
3b78e42
Compare
Morriar
force-pushed
the
nitx-commands
branch
from
3b78e42
to
be1696d
Compare
|
reroll:
|
|
Morriar
force-pushed
the
nitx-commands
branch
from
be1696d
to
2d9d791
Compare
Signed-off-by: Alexandre Terrasa <alexandre@moz-code.org>
Signed-off-by: Alexandre Terrasa <alexandre@moz-code.org>
Morriar
force-pushed
the
nitx-commands
branch
from
2d9d791
to
bad441d
Compare
|
Reroll:
|
Signed-off-by: Alexandre Terrasa <alexandre@moz-code.org>
Signed-off-by: Alexandre Terrasa <alexandre@moz-code.org>
Signed-off-by: Alexandre Terrasa <alexandre@moz-code.org>
Signed-off-by: Alexandre Terrasa <alexandre@moz-code.org>
Morriar
force-pushed
the
nitx-commands
branch
from
bad441d
to
85de593
Compare
privat
added a commit
that referenced
this pull request
Dec 19, 2017
Three things in this PR: * `nitx` now uses doc-commands (and related cleaning), bye bye the heavy `DocModel` with pre built `DocPages` * More tests for `nitx` * Move `nitx` to the `doc` tools suite, the group is now known as `doc::term` Pull-Request: #2591 Reviewed-by: Jean Privat <jean@pryen.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Three things in this PR:
nitxnow uses doc-commands (and related cleaning), bye bye the heavyDocModelwith pre builtDocPagesnitxnitxto thedoctools suite, the group is now known asdoc::term