|
distortion park posted:what's the godoc reason for comments having to end in periods? feels like a solution in search of a problem forces you to write in complete sentences, such as this one: "."
|
#
?
Jul 27, 2022 19:01
|
|
|
|
| # ? Apr 28, 2024 00:10 |
|
|
pokeyman posted:forces you to write in complete sentences, such as this one: "." i don't understand why would that require someone to use sentences it doesn't make much sense at all if you think about it it's not even clear the complete sentences are necessary for producing good documentation in all cases but what do i know ._.
|
|
#
?
Jul 27, 2022 19:09
|
|
|
anime.
|
|
#
?
Jul 27, 2022 19:12
|
|
|
leper khan posted:i don't understand why would that require someone to use sentences it doesn't make much sense at all if you think about it it's not even clear the complete sentences are necessary for producing good documentation in all cases but what do i know ._. ok my real answer in short is "makes u think" and in long is it prods people to expand empty/terse comments into full sentences, under the assumption that the former tends not to bother with trailing punctuation. the other day a coworker ran into an aws config linter that demanded a description string start with an uppercase letter and end with a period if I added a new method to a public api and my local build failed with a "please document this with more than zero effort", I'd appreciate it
|
|
#
?
Jul 27, 2022 19:35
|
|
|
it's also the kind of lint rule that might lead people to contortions, I agree like forums with minimum character limits on posts so people reply with "Yes! (added padding to get around the limit)"
|
|
#
?
Jul 27, 2022 19:37
|
|
|
The more rules we put on source code documentation at an old gig of mine the more obvious it became that English was the second or third language of at least half the dev team
|
|
#
?
Jul 27, 2022 19:55
|
|
|
Edit: Quote is not edit!
|
|
#
?
Jul 27, 2022 19:55
|
|
|
mystes posted:You're going to love the next 100 incompatible npm replacements that are about to come out then! its all trash. node is trash, javascript is trash, angular is trash, bootstrap is trash, html is trash, the web is trash.
|
|
#
?
Jul 27, 2022 20:01
|
|
|
Carthag Tuek posted:its all trash. node is trash, javascript is trash, angular is trash, bootstrap is trash, html is trash, the web is trash.
|
|
#
?
Jul 27, 2022 20:54
|
|
|
encourages you to delete your comments
|
|
#
?
Jul 27, 2022 21:11
|
|
|
i'm normally all in favor of having computers check things as much as possible instead of humans, but documentation seems like the sort of thing that unavoidably needs a human reviewing it.
|
|
#
?
Jul 27, 2022 22:02
|
|
|
anything that means I don’t have to make the same comments I’m sick of making on the PR gets a pass with me
|
|
#
?
Jul 27, 2022 22:12
|
|
|
ArcticZombie posted:anything that means I don’t have to make the same comments I’m sick of making on the PR gets a pass with me this is 100% the point of linting and auto-formatting. no time wasted on the color of this particular bike shed, the pipeline passes or it doesn't it was a huge pain to argue through all of this at work but now that it's in place reviewing PRs is much nicer
|
|
#
?
Jul 27, 2022 23:00
|
|
|
fart simpson posted:hi jeoh hey buddy
|
|
#
?
Jul 27, 2022 23:02
|
|
|
leper khan posted:i don't understand why would that require someone to use sentences it doesn't make much sense at all if you think about it it's not even clear the complete sentences are necessary for producing good documentation in all cases but what do i know ._. go’s linting rules for comments are: code:in reality i see this a whole lot: code:Blinkz0rz fucked around with this message at 01:05 on Jul 28, 2022 |
|
#
?
Jul 28, 2022 00:34
|
|
|
it I had comment rules that demanded full sentences then the end result would be no comments and people would say that the code is self-documenting
|
|
#
?
Jul 28, 2022 00:52
|
|
|
also, at this point, forget about commenting out test code for quick fixes, or putting in an example of how to call an API. Even pseudocode would get dinged. For pseudocode or example api calls, I would scrap the "complete sentence" requirements.
|
|
#
?
Jul 28, 2022 00:54
|
|
|
new guy on the team opened his first pr to change all the linting rules because he didnt like them. what a power move
|
|
#
?
Jul 28, 2022 04:19
|
|
|
|
|
#
?
Jul 28, 2022 04:21
|
|
|
plot twist: no linter was currently being used and the new guy was proposing they try one out
|
|
#
?
Jul 28, 2022 04:48
|
|
|
i actually had an old hand make an argument like that when i joined a past gig. sysadmin type work, everything was managed directly from his workstation and only occasionally in any form of source control. i started an ansible repo that described a single file i was deploying to hosts (to act as a starting point for collab and test the waters) and he raised hell up the flag pole that i was trying to change all his workflows on day one.
|
|
#
?
Jul 28, 2022 04:52
|
|
|
the best change was screen print width from 80 to 100. huge value
|
|
#
?
Jul 28, 2022 04:56
|
|
|
barkbell posted:the best change was screen print width from 80 to 100. huge value as someone who has been too lazy to reconfigure default terminal width for a couple decades now, i'd have to agree with you. that's a wtf pr right there.
|
|
#
?
Jul 28, 2022 05:19
|
|
|
Blinkz0rz posted:go’s linting rules for comments are: Repeating the function name as the first thing is stupid. The name is already right there.
|
|
#
?
Jul 28, 2022 06:39
|
|
|
the only linter you need for golang is rm -rf
|
|
#
?
Jul 28, 2022 09:08
|
|
|
cargo is a piece of poo poo it's crazy how bad it is in contrast to how good rust is, overall. but cargo loving sucks
|
|
#
?
Jul 28, 2022 11:33
|
|
|
tazjin posted:cargo is a piece of poo poo i've only used it twice for small-ish programs. When does it go into terribad territory?
|
|
#
?
Jul 28, 2022 11:35
|
|
|
champagne posting posted:i've only used it twice for small-ish programs. When does it go into terribad territory? cargo has a happy flow: write a simple program downloading a bunch of dependencies on a single machine (probably ideally a mac, as that is what every developer uses!), never do builds anywhere else, hope that nothing in your environment is "weird" it gets into bad territory if you have literally any other situation, and it usually breaks in astounding ways. right now i'm having some problem with its libgit implementation being unable to update the package index (which is a multi-gigabyte github repo it clones to your machine!!!) and throwing absurd error messages ('target OID for the reference doesn't exist on the repository; class=Reference (4)'), there being no manual override for when to do this updating (i already have this crap locally!! just use the files on my disk!!!), and all previous workarounds that people have posted in obscure stackoverflow posts being "deprecated" in cargo itself. there's a reason that in many "serious" uses of rust people have replaced the build system with something else, but i just want to build a stupid tiny program i already have, not write yet another rust build system.
|
|
#
?
Jul 28, 2022 11:40
|
|
|
it also has utterly terrible artifact caching logic, literally babby's first artifact cache, and it's impossible to disable any of its crazy behaviours that are tailored to whatever workflow its original developers (who i think all came from js/ruby) were thinking about
|
|
#
?
Jul 28, 2022 11:42
|
|
|
well, 
|
|
#
?
Jul 28, 2022 11:52
|
|
|
speaking of rust, how many projects are there that actually have rust as a compilation target? because i was following this f#-to-js project, and they recently made it possible to write alternative backends for it, and well... i think people are going a little bit too crazy with it  https://fable.io/blog/2022/2022-06-06-Snake_Island_alpha.html demo here ok sure, it's just an extra module and won't impact the main JS project, and python kinda makes sense, but still... php? NihilCredo fucked around with this message at 12:01 on Jul 28, 2022 |
|
#
?
Jul 28, 2022 11:58
|
|
|
is there any language package manager which isn't a huge pile of crap
|
|
#
?
Jul 28, 2022 12:21
|
|
|
Zlodo posted:is there any language package manager which isn't a huge pile of crap lol
|
|
#
?
Jul 28, 2022 12:22
|
|
|
Zlodo posted:is there any language package manager which isn't a huge pile of crap I've found this to be an impossible task because you invariably have users who want a zero-setup "just works by picking the name of the package" approach who will be sitting in the same room as "wants web-of-trust with supply chain audit reports" and they'll work on the same project, with all their packages versioned 0.0.1 and asking for semver to resolve all issues. You can get decent results for specific use cases, but there's no good universal management because some things are in tension forever: eg. providing namespaces for packages tends to create more forking, whereas having a single global namespace leads to consolidation of drivers and libraries. People will want to work on their own publishable fork, but doing so will create an ecosystemic effect where packages get diluted, which makes other users complain.
|
|
#
?
Jul 28, 2022 12:35
|
|
|
yeah I've been happily running cargo for years and never ran into any of the weird libgit issues tazjin is reporting. it seems like you can have really terrible luck with this kind of tooling and then everything seems to suck (or, in fact, DOES suck) but I haven't had that experience.
|
|
#
?
Jul 28, 2022 12:43
|
|
|
Sagacity posted:yeah I've been happily running cargo for years and never ran into any of the weird libgit issues tazjin is reporting. it seems like you can have really terrible luck with this kind of tooling and then everything seems to suck (or, in fact, DOES suck) but I haven't had that experience. the libgit crap is just today's cargo issue, in a month i can probably collect 5 of these. my curse is that all software i use breaks in crazy ways all of the time, but it is a lucrative curse if you know how to utilise it (and can replenish the nerves it costs regularly)
|
|
#
?
Jul 28, 2022 12:45
|
|
|
Zlodo posted:is there any language package manager which isn't a huge pile of crap maven's package management stuff works. nuget would be ok if it didnt have support for scripting lol
|
|
#
?
Jul 28, 2022 15:21
|
|
|
tazjin posted:the libgit crap is just today's cargo issue, in a month i can probably collect 5 of these. my curse is that all software i use breaks in crazy ways all of the time, but it is a lucrative curse if you know how to utilise it (and can replenish the nerves it costs regularly) Are you programming on top of a civil war battle site? Do you naturally produce unsafe levels of RF radiation? I’ve been using cargo for years at this point and haven’t managed to surface something like this, despite doing lots of poo poo where I cross-compile multiple c libs down to arm6hf, while also not developing on MacOS.
|
|
#
?
Jul 28, 2022 15:22
|
|
|
wait, cargo looked at cocoapods's decision to make the package index a git repo that caused github to say "pls no we can't handle the traffic" and said "let's copy that"?
|
|
#
?
Jul 28, 2022 16:12
|
|
|
|
| # ? Apr 28, 2024 00:10 |
|
|
They’re publicly testing the new http index now at least
|
|
#
?
Jul 28, 2022 16:14
|
|