siracusa,
@siracusa@mastodon.social avatar

The Swift API guidelines are really good. They’re worth reading even if you’re not interested in Swift just to see an example of how to communicate this kind of information well. https://www.swift.org/documentation/api-design-guidelines/

jann,
@jann@twit.social avatar

@siracusa is this posting a joke, John? 😉

joshhunt,
@joshhunt@hachyderm.io avatar

@siracusa Breath of fresh air compared to the golang naming guides https://go.dev/wiki/CodeReviewComments#variable-names

siracusa,
@siracusa@mastodon.social avatar

They even included my top tip for API design (which doubles as yet another reason to write documentation).

khad,
@khad@mastodon.social avatar

@siracusa So true. When dealing with customer-facing docs, I used to always say, “If it’s hard to document, it’s hard to use.”

jjoelson,
@jjoelson@mastodon.social avatar

@siracusa I’m not an advocate, but this is also the same basic insight that drives test driven development: the idea of thinking very clearly about what you’re trying to accomplish separately from writing implementation code.

kjhealy,
@kjhealy@mastodon.social avatar

@siracusa Of course, nothing is so perfect …

siracusa,
@siracusa@mastodon.social avatar

@kjhealy But then it has examples!

chrisfinazzo,
@chrisfinazzo@mastodon.social avatar

@siracusa @kjhealy English is a stupid language. 🫠

  • All
  • Subscribed
  • Moderated
  • Favorites
  • random
  • ngwrru68w68
  • DreamBathrooms
  • thenastyranch
  • magazineikmin
  • InstantRegret
  • GTA5RPClips
  • Youngstown
  • everett
  • slotface
  • rosin
  • osvaldo12
  • mdbf
  • kavyap
  • cubers
  • megavids
  • modclub
  • normalnudes
  • tester
  • khanakhh
  • Durango
  • ethstaker
  • tacticalgear
  • Leos
  • provamag3
  • anitta
  • cisconetworking
  • JUstTest
  • lostlight
  • All magazines