cap line length for .kt files to 80 in src/docs #790
Conversation
|
Anyway, wanted to check back before I go through every file and check what the IDEA formatter did. |
Codecov Report
@@ Coverage Diff @@
## master #790 +/- ##
=========================================
Coverage 84.65% 84.65%
Complexity 1548 1548
=========================================
Files 473 473
Lines 10768 10768
Branches 1400 1400
=========================================
Hits 9116 9116
Misses 974 974
Partials 678 678 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
Yeah, seems like a legit change. Happy to do it if we can limit the length just in the docs folder (I think we use 120 elsewhere) |
|
Yeah, checked it and it's working as intended. It's also only targeting Kotlin files, nothing else. Let me take care of it and have a look later on. 👍 |
.editorconfig
Outdated
| [src/docs/*/**.kt] | ||
| max_line_length = 80 |
| fun readFile(secretKey: String, bucketKey: String): ByteBuffer { | ||
| return s3(Request(GET, "https://mybucket.s3.amazonaws.com/$bucketKey")).body.payload | ||
| } | ||
| fun readFile(secretKey: String, bucketKey: String): ByteBuffer = |
There was a problem hiding this comment.
secretKey is not being used - not sure if intended. (Corresponding Docs)
|
Please not 80 we're no longer in old Unix system, we have 4k-6k screens I hate all the white space on the web because everyone thing we are still in 1024px... Anyway 120 is what fits on a standard HD screen with left and right panels of IntelliJ so IMHO is a minimum and a good enough compromise. |
|
@razvn this is only for the website docs content, so am happy to go with whatever fits on most people's screens. Seems to be about 95 on my screen. Definitely NOT the IDE 😄 |
|
Hey @razvn, it's not about the general code style in the repo, it's just about the docs that are being shown when browsing the docs. There's a lot of horizontal scrolling: |
|
Here's a better example with text above it and full screen: |
|
We could also go for 95 @daviddenton - should also work fine. Wdyt? |
|
Yeah - 95 works better. Will be reasonable to code against whilst being readable. Thanks for picking this up BTW @p10r - docs are important! 😄 |
| val portLens: Lens<Environment, Port> = | ||
| EnvironmentKey.int().map(::Port).defaulted("PORT", Port(9000)) |
There was a problem hiding this comment.
We could also go for
val portLens: Lens<Environment, Port> = EnvironmentKey.int()
.map(::Port)
.defaulted("PORT", Port(9000))But, if I remember correctly, the rest of the code base is not splitting lines after each method call, right?
This is also for my own reading experience, so happy to jump in there. 🌚 |
|
I also went through the markdown files. Looks good so far - I'll create a follow-up if I ever find another occurence. |
|
thanks again :) |
|
Thanks for building such a library ❤️ |
Some of the docs currently look like this:
One has to use horizontal scrolling to see the whole code (Firefox, MBP 2019, no zoom)
Suggestion: Applying
max_line_length = 80for all Kotlin files insrc/docs, so everything fits on the screen without scrolling.Searched around for this and it seems like this was already a thing in the slack channel, but seems like the PR was never opened(?).