-
Notifications
You must be signed in to change notification settings - Fork 418
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Checksum example: add Kotlin source code on second tab #1201
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1201 +/- ##
=========================================
Coverage 94.30% 94.30%
Complexity 455 455
=========================================
Files 2 2
Lines 6676 6676
Branches 1795 1795
=========================================
Hits 6296 6296
Misses 102 102
Partials 278 278 Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall, I like this idea!
I had a minor comment on the positional parameter: it should not have a default value because we want it to be a required parameter.
I merged the change but I get this error when running
|
This might be an In general, |
Yes, we are using Gradle 6.6: The upgrade was needed to build on Java 15... (gradle/gradle#13628) If there is no workaround we may need to backtrack and wait until gradle/gradle#14727 is fixed. |
Completely different topic: I noticed that your contributions are not counted correctly here. Could it be that the email address that you used to commit is not registered in GitHub? I suspect that if you add that email address, the stats will show up correctly. |
I just noticed your questions (sorry, bit hectic here)...
This is a long time ago and I honestly don't remember. I should have made notes. I think it was because I was also experimenting with dark themes and those did not work together but not sure anymore. (About dark themes, I decided against it because I felt it takes away (lessens the "wow" factor) from the screenshots showing picocli's use of ANSI colors.)
Not sure what you mean with this. Are some descriptions very language-specific? Should be fine to change in general I think. One exception may be the Picocli in Other Languages section, where I think we should not used tabbed examples with multiple languages: better to keep each subsection focused on its own language.
For the first (
Hm, not sure. We would have to experiment a bit. I worry a bit that having four links under each example may be distracting for readers. Also, it may become a maintenance burden: if we need to change an example we would need to change the asciidoc, but also four different files on JDoodle. I would not go overboard with JDoodle for now. If we do anything, perhaps just a few strategic examples at most. |
Thanks for poiting that out! |
Absolutely. Stay tuned, I will author a PR for this soon.
I agree. Let's see what I can do here. As said, it may take some time, but I'm willing to work on this. About maintenance burden: |
This PR adds a second tab to the checksum souce code, showing the Kotlin version of the app.
I hope you like the idea (as I do).
This is work in progress, and I'm willing to push this a bit further. Prior to that, I would like your info/opinion on the following topics:
I realized that current
coderay
source highlighter does not support kotlin yet. Source highlighterhighlight-js
supports much more languages. I see thathighlight-js
is mentioned in the header ofindex.adoc
, it is commented out, however. Did you experiment withhighlight-js
already? What were you experiences? Why did you abandon it?With source codes available in multiple languages, we have to keep the description of the code (especially in the source code) as generic as possible. I had a quick look on the current descrption and had the impression that providing one single description for all languages should be doable. What do yo think?
The concept of multiple tabs opens up many possibilites, and we have to restrict ourselves a bit, I guess.
I'm curious what you think here!