[{"_1":2,"_656":-5,"_657":-5},"loaderData",{"_3":4,"_18":19},"root",{"_5":6,"_7":6,"_8":9,"_10":11,"_12":13,"_14":15,"_16":17},"isProd",true,"enableStats","domain","hyper.media","siteHost","ui-with-state-machines.hyper.media","sentryTrace","7389fc230121435e8148f2cd3b6508e5--0","sentryBaggage","sentry-environment=production,sentry-trace_id=7389fc230121435e8148f2cd3b6508e5,sentry-sampled=false","remixVersion",2,"routes/$",{"_20":21,"_616":617},"json",{"_22":23,"_24":25,"_26":-5,"_27":-5,"_28":-5,"_29":30,"_31":-5,"_32":33,"_272":6,"_43":273,"_284":285,"_286":287,"_602":603,"_604":30,"_10":605,"_606":605,"_607":608,"_611":612},"prefersLanguages",[],"viewTerm","comments","panelParam","openComment","accountUid","isInspect",false,"inspectTab","document",{"_34":35,"_248":191,"_249":250,"_251":252,"_253":254,"_255":256,"_257":258,"_259":260,"_263":264,"_265":61,"_266":267,"_270":271},"content",[36,55,82,119,136,222],{"_37":38,"_39":40},"children",[],"block",{"_41":42,"_43":44,"_45":46,"_47":48,"_49":50,"_51":52,"_53":54},"type","Paragraph","id","72Q4eVjX","revision","bafy2bzacecvex2ujznpt7uow3oh7dackklkr7rmpa26tbns4rol4igh6mrtue","attributes",{},"annotations",[],"text","I have a pet peeve about naming fields in APIs and data structures (classes, structs, maps, dicts, whatever you call them) — I hate when fields are not nouns. I especially hate it when most fields are nouns, but some others aren't.","link","",{"_37":56,"_39":65},[57],{"_37":58,"_39":59},[],{"_41":42,"_43":60,"_45":61,"_47":62,"_49":63,"_51":64,"_53":54},"KJ08jTMQ","bafy2bzaceb5xikhajlpzki4rorifut3kxk2qfb7q3ickzvos4lzcsld4g2m2w",{},[],"There're some things to disagree with in these guidelines, but I think this rule is actually a very good one.",{"_41":42,"_43":66,"_45":61,"_47":67,"_49":70,"_51":81,"_53":54},"WpgNnl-m",{"_68":69},"childrenType","Group",[71],{"_41":72,"_73":74,"_76":77,"_47":79,"_53":80},"Link","starts",[75],93,"ends",[78],102,{},"https://google.aip.dev/140","I probably picked it up from using Google APIs quite a bit in the past — there's this Google guideline for field naming in their Protobuf APIs, that among other things suggests to use nouns for all the fields.",{"_37":83,"_39":91},[84],{"_37":85,"_39":86},[],{"_41":42,"_43":87,"_45":61,"_47":88,"_49":89,"_51":90,"_53":54},"o_SGfgjl",{},[],"I guess it comes from Ruby on Rails and its Active Record system, which then has spread everywhere. ",{"_41":42,"_43":92,"_45":61,"_47":93,"_49":94,"_51":118,"_53":54},"ecZ-UVrQ",{"_68":69},[95],{"_41":96,"_73":97,"_76":107,"_47":117,"_53":54},"Code",[98,99,100,101,102,103,104,105,106],97,111,216,222,229,248,262,290,303,[108,109,110,111,112,113,114,115,116],106,120,220,227,236,257,271,294,310,{},"The simplest example of what annoys me is the very commonly used names for lifecycle timestamps: createdAt and updatedAt. So there would be a structure describing something like a user, and it would have fields like name, email, address, and those createdAt and updatedAt fields. Why is it name and not namedAs then? Why those fields in particular are not nouns?",{"_37":120,"_39":121},[],{"_41":42,"_43":122,"_45":61,"_47":123,"_49":124,"_51":135,"_53":54},"xczjp_e9",{},[125],{"_41":96,"_73":126,"_76":130,"_47":134,"_53":54},[75,127,128,129],103,117,130,[131,108,132,133],98,125,136,{},"But then you'd see something describing like a calendar event, and it would have fields like start and end — why not startsAt and endsAt or something like this then?",{"_37":137,"_39":216},[138,162,187],{"_37":139,"_39":140},[],{"_41":42,"_43":141,"_45":61,"_47":142,"_49":143,"_51":161,"_53":54},"wFVY5lLY",{},[144,151],{"_41":72,"_73":145,"_76":147,"_47":149,"_53":150},[146],4,[148],12,{},"https://www.w3.org/TR/did-1.0/#did-document-properties",{"_41":96,"_73":152,"_76":156,"_47":160,"_53":54},[153,154,155],25,108,119,[157,158,159],36,115,133,{},"The DID spec has a weird alsoKnownAs field among all the other fields that are nouns. Couldn't they call it aliases or alternateNames or something like that?",{"_37":163,"_39":164},[],{"_41":42,"_43":165,"_45":61,"_47":166,"_49":167,"_51":186,"_53":54},"zCDhLs-Z",{},[168,174],{"_41":72,"_73":169,"_76":170,"_47":172,"_53":173},[146],[171],13,{},"https://github.com/ucan-wg/ucan-ipld/?tab=readme-ov-file#22-capability",{"_41":96,"_73":175,"_76":180,"_47":185,"_53":54},[176,177,178,179],40,49,135,148,[181,182,183,184],44,52,143,155,{},"The UCAN spec that has field names like with and can which you will never know the meaning of by just looking at the data. I find that resource and ability would be much better.",{"_37":188,"_39":189},[],{"_41":42,"_43":190,"_45":191,"_47":192,"_49":193,"_51":215,"_53":54},"sTYYBpAq","bafy2bzacecak3hjs5rdnb3o3j6wyb656fejiv5btasmyjernbvhzr7yjbabky",{},[194,201,208],{"_41":72,"_73":195,"_76":197,"_47":199,"_53":200},[196],58,[198],62,{},"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsuses",{"_41":72,"_73":202,"_76":204,"_47":206,"_53":207},[203],67,[205],71,{},"https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idstepswith",{"_41":96,"_73":209,"_76":211,"_47":214,"_53":54},[178,210],146,[212,213],141,151,{},"GitHub Actions workflow definitions that have fields like uses and with, which I always mess up and forget what they mean. I find that action and input or something like that would be much better.",{"_41":42,"_43":217,"_45":61,"_47":218,"_49":220,"_51":221,"_53":54},"0d_N5o0-",{"_68":219},"Unordered",[],"Some other examples:",{"_37":223,"_39":224},[],{"_41":42,"_43":225,"_45":61,"_47":226,"_49":227,"_51":247,"_53":54},"VViL9UaA",{},[228,235],{"_41":72,"_73":229,"_76":231,"_47":233,"_53":234},[230],121,[232],149,{},"https://google.aip.dev/142",{"_41":96,"_73":236,"_76":241,"_47":246,"_53":54},[237,238,239,240],168,188,200,212,[242,243,244,245],185,198,210,221,{},"Finding a good noun for a timestamp is probably the hardest thing, so I keep following the Google's guideline (there's a different one for timestamps) and call them as {imperative}_time — createTime, updateTime, startTime and so on. Sometimes the resulting word won't be a proper English word, but I'm OK with that for the purposes of consistency.","version","account","z6MkgYR76i3w2Xc2fcvgFJWfYjsop6YwUonDhQx3AdLmQ4BQ","authors",[250],"path","/notes/use-nouns-for-your-fields","createTime","2025-05-06T09:59:11.631Z","updateTime","2025-11-18T13:41:10.393Z","metadata",{"_261":262},"name","Use Nouns for Your Fields","detachedBlocks",{},"genesis","generationInfo",{"_265":61,"_268":269},"generation","1746525551630","visibility","PUBLIC","isLatest",{"_253":274,"_248":191,"_277":6,"_278":250,"_43":279,"_280":-5,"_281":-5,"_282":-5,"_283":-5},[275,276],"notes","use-nouns-for-your-fields","latest","uid","hm://z6MkgYR76i3w2Xc2fcvgFJWfYjsop6YwUonDhQx3AdLmQ4BQ/notes/use-nouns-for-your-fields","blockRef","blockRange","hostname","scheme","siteHomeIcon","ipfs://bafkreidm54rhouk5rjrzzh75kfy6de72rlefi2xdhv2plfeg2k6sau5ky4","dehydratedState",{"_288":289,"_290":291},"mutations",[],"queries",[292,429,477,524,530,545,591],{"_293":294,"_424":425,"_427":428},"state",{"_295":296,"_408":409,"_410":411,"_412":-5,"_413":414,"_415":414,"_416":414,"_417":-5,"_418":-5,"_419":30,"_420":421,"_422":423},"data",{"_41":32,"_32":297,"_43":406},{"_34":298,"_248":191,"_249":250,"_251":402,"_253":254,"_255":256,"_257":258,"_259":403,"_263":404,"_265":61,"_266":405,"_270":271},[299,304,318,332,341,389],{"_37":300,"_39":301},[],{"_41":42,"_43":44,"_45":46,"_47":302,"_49":303,"_51":52,"_53":54},{},[],{"_37":305,"_39":311},[306],{"_37":307,"_39":308},[],{"_41":42,"_43":60,"_45":61,"_47":309,"_49":310,"_51":64,"_53":54},{},[],{"_41":42,"_43":66,"_45":61,"_47":312,"_49":313,"_51":81,"_53":54},{"_68":69},[314],{"_41":72,"_73":315,"_76":316,"_47":317,"_53":80},[75],[78],{},{"_37":319,"_39":325},[320],{"_37":321,"_39":322},[],{"_41":42,"_43":87,"_45":61,"_47":323,"_49":324,"_51":90,"_53":54},{},[],{"_41":42,"_43":92,"_45":61,"_47":326,"_49":327,"_51":118,"_53":54},{"_68":69},[328],{"_41":96,"_73":329,"_76":330,"_47":331,"_53":54},[98,99,100,101,102,103,104,105,106],[108,109,110,111,112,113,114,115,116],{},{"_37":333,"_39":334},[],{"_41":42,"_43":122,"_45":61,"_47":335,"_49":336,"_51":135,"_53":54},{},[337],{"_41":96,"_73":338,"_76":339,"_47":340,"_53":54},[75,127,128,129],[131,108,132,133],{},{"_37":342,"_39":386},[343,356,369],{"_37":344,"_39":345},[],{"_41":42,"_43":141,"_45":61,"_47":346,"_49":347,"_51":161,"_53":54},{},[348,352],{"_41":72,"_73":349,"_76":350,"_47":351,"_53":150},[146],[148],{},{"_41":96,"_73":353,"_76":354,"_47":355,"_53":54},[153,154,155],[157,158,159],{},{"_37":357,"_39":358},[],{"_41":42,"_43":165,"_45":61,"_47":359,"_49":360,"_51":186,"_53":54},{},[361,365],{"_41":72,"_73":362,"_76":363,"_47":364,"_53":173},[146],[171],{},{"_41":96,"_73":366,"_76":367,"_47":368,"_53":54},[176,177,178,179],[181,182,183,184],{},{"_37":370,"_39":371},[],{"_41":42,"_43":190,"_45":191,"_47":372,"_49":373,"_51":215,"_53":54},{},[374,378,382],{"_41":72,"_73":375,"_76":376,"_47":377,"_53":200},[196],[198],{},{"_41":72,"_73":379,"_76":380,"_47":381,"_53":207},[203],[205],{},{"_41":96,"_73":383,"_76":384,"_47":385,"_53":54},[178,210],[212,213],{},{"_41":42,"_43":217,"_45":61,"_47":387,"_49":388,"_51":221,"_53":54},{"_68":219},[],{"_37":390,"_39":391},[],{"_41":42,"_43":225,"_45":61,"_47":392,"_49":393,"_51":247,"_53":54},{},[394,398],{"_41":72,"_73":395,"_76":396,"_47":397,"_53":234},[230],[232],{},{"_41":96,"_73":399,"_76":400,"_47":401,"_53":54},[237,238,239,240],[242,243,244,245],{},[250],{"_261":262},{},{"_265":61,"_268":269},{"_43":279,"_278":250,"_253":407,"_248":191,"_280":-5,"_281":-5,"_282":-5,"_283":-5,"_277":6},[275,276],"dataUpdateCount",1,"dataUpdatedAt",1776850808587,"error","errorUpdateCount",0,"errorUpdatedAt","fetchFailureCount","fetchFailureReason","fetchMeta","isInvalidated","status","success","fetchStatus","idle","queryKey",[426,279,191,6],"ENTITY","queryHash","[\"ENTITY\",\"hm://z6MkgYR76i3w2Xc2fcvgFJWfYjsop6YwUonDhQx3AdLmQ4BQ/notes/use-nouns-for-your-fields\",\"bafy2bzacecak3hjs5rdnb3o3j6wyb656fejiv5btasmyjernbvhzr7yjbabky\",true]",{"_293":430,"_424":475,"_427":476},{"_295":431,"_408":409,"_410":474,"_412":-5,"_413":414,"_415":414,"_416":414,"_417":-5,"_418":-5,"_419":30,"_420":421,"_422":423},{"_41":32,"_32":432,"_43":471},{"_34":433,"_248":456,"_249":250,"_251":457,"_253":54,"_255":458,"_257":459,"_259":460,"_263":463,"_265":468,"_266":469,"_270":271},[434,442],{"_37":435,"_39":436},[],{"_41":42,"_43":437,"_45":438,"_47":439,"_49":440,"_51":441,"_53":54},"OT1yMv4E","bafy2bzacebcppa5qne4xggxc4ry3wan34hn5qov3ljhjxcgnoljafri3zy3i2",{},[],"Co-founder at Seed Hypermedia.",{"_37":443,"_39":444},[],{"_41":42,"_43":445,"_45":438,"_47":446,"_49":447,"_51":455,"_53":54},"u1Gebz4m",{},[448],{"_41":449,"_73":450,"_76":452,"_47":453,"_53":454},"Embed",[451],24,[153],{},"hm://z6MkgYR76i3w2Xc2fcvgFJWfYjsop6YwUonDhQx3AdLmQ4BQ/notes","I write random stuff in .","bafy2bzacea6fd72k47wlvgd4hc33vbxbmlca6siu4tcg2p66aizpqkbfrpd2e",[250],"1970-01-01T00:00:00Z","2025-08-06T11:51:54.558Z",{"_261":461,"_462":285},"Alex Burdiyan","icon",{"_464":465},"navigation",{"_37":466,"_39":467},[],{"_41":69,"_43":464},"bafy2bzacecoylsutxi6enonsjtjh4nukax6u56txfp4oqdhxyupd3id7y7hri",{"_265":468,"_268":470},"0",{"_43":472,"_278":250,"_253":473,"_248":-5,"_280":-5,"_281":-5,"_282":-5,"_283":-5,"_277":6},"hm://z6MkgYR76i3w2Xc2fcvgFJWfYjsop6YwUonDhQx3AdLmQ4BQ",[],1776850808590,[426,472,-5,6],"[\"ENTITY\",\"hm://z6MkgYR76i3w2Xc2fcvgFJWfYjsop6YwUonDhQx3AdLmQ4BQ\",null,true]",{"_293":478,"_424":520,"_427":523},{"_295":479,"_408":409,"_410":519,"_412":-5,"_413":414,"_415":414,"_416":414,"_417":-5,"_418":-5,"_419":30,"_420":421,"_422":423},[480],{"_41":32,"_43":481,"_253":484,"_251":485,"_255":486,"_257":491,"_494":495,"_265":496,"_248":483,"_497":498,"_501":502,"_266":513,"_515":-5,"_259":516,"_270":271},{"_43":454,"_278":250,"_253":482,"_248":483,"_280":-5,"_281":-5,"_282":-5,"_283":-5,"_277":6},[275],"bafy2bzaceaffa56wzeirgglikas7wpfnwrzi2pwft75ppte3265zg73myzcf4",[275],[250],{"_487":488,"_489":490},"seconds","1738791711","nanos",358000000,{"_487":492,"_489":493},"1749469352",17000000,"sortTime","2025-02-05T21:41:51.358Z","bafy2bzacebebhhgbjkqeb76mhpo2tkac7jbpmqxduhx3dhz7e2xj22fbv5y6s","breadcrumbs",[499],{"_261":461,"_253":54,"_500":30},"isMissing","activitySummary",{"_503":504,"_507":508,"_509":409,"_510":511,"_512":6},"latestCommentTime",{"_487":505,"_489":506},"1742983940",186000000,"latestCommentId","z6MkrbYsRzKb1VABdvhsDSAk6JK8fAszKsyHhcaZigYeWCou/z6AbwYTF2SwiDa","commentCount","latestChangeTime",{"_487":492,"_489":493},"isUnread",{"_265":496,"_268":514},"1738791711358","redirectInfo",{"_261":517,"_518":30},"Notes","showOutline",1776850808589,[521,472,522],"DOC_LIST_DIRECTORY","Children","[\"DOC_LIST_DIRECTORY\",\"hm://z6MkgYR76i3w2Xc2fcvgFJWfYjsop6YwUonDhQx3AdLmQ4BQ\",\"Children\"]",{"_293":525,"_424":528,"_427":529},{"_295":526,"_408":409,"_410":527,"_412":-5,"_413":414,"_415":414,"_416":414,"_417":-5,"_418":-5,"_419":30,"_420":421,"_422":423},[],1776850808591,[521,279,522],"[\"DOC_LIST_DIRECTORY\",\"hm://z6MkgYR76i3w2Xc2fcvgFJWfYjsop6YwUonDhQx3AdLmQ4BQ/notes/use-nouns-for-your-fields\",\"Children\"]",{"_293":531,"_424":542,"_427":544},{"_295":532,"_408":409,"_410":541,"_412":-5,"_413":414,"_415":414,"_416":414,"_417":-5,"_418":-5,"_419":30,"_420":421,"_422":423},{"_533":414,"_25":17,"_534":535,"_37":414,"_536":537,"_539":540},"citations","changes",3,"authorUids",[538,250],"z6MkrbYsRzKb1VABdvhsDSAk6JK8fAszKsyHhcaZigYeWCou","blocks",{},1776850808610,[543,279],"DOCUMENT_INTERACTION_SUMMARY","[\"DOCUMENT_INTERACTION_SUMMARY\",\"hm://z6MkgYR76i3w2Xc2fcvgFJWfYjsop6YwUonDhQx3AdLmQ4BQ/notes/use-nouns-for-your-fields\"]",{"_293":546,"_424":589,"_427":590},{"_295":547,"_408":409,"_410":519,"_412":-5,"_413":414,"_415":414,"_416":414,"_417":-5,"_418":-5,"_419":30,"_420":421,"_422":423},{"_41":32,"_32":548,"_43":587},{"_34":549,"_248":483,"_249":250,"_251":581,"_253":582,"_255":495,"_257":583,"_259":584,"_263":585,"_265":496,"_266":586,"_270":271},[550,557],{"_37":551,"_39":552},[],{"_41":42,"_43":553,"_45":496,"_47":554,"_49":555,"_51":556,"_53":54},"8nZQ3bsG",{},[],"Here I'll be publishing some random notes, thoughts, and other arbitrary stuff.",{"_37":558,"_39":559},[],{"_41":560,"_43":561,"_45":483,"_47":562,"_49":580,"_51":54,"_53":54},"Query","qt6S1m5Q",{"_563":535,"_564":565,"_566":567,"_579":30},"columnCount","style","List","query",{"_568":569,"_573":574},"includes",[570],{"_571":250,"_253":275,"_572":522},"space","mode","sort",[575],{"_576":30,"_577":578},"reverse","term","CreateTime","banner",[],[250],"/notes","2025-06-09T11:42:32.017Z",{"_261":517,"_518":30},{},{"_265":496,"_268":514},{"_43":454,"_278":250,"_253":588,"_248":-5,"_280":-5,"_281":-5,"_282":-5,"_283":-5},[275],[426,454,-5,30],"[\"ENTITY\",\"hm://z6MkgYR76i3w2Xc2fcvgFJWfYjsop6YwUonDhQx3AdLmQ4BQ/notes\",null,false]",{"_293":592,"_424":599,"_427":601},{"_295":593,"_408":409,"_410":598,"_412":-5,"_413":414,"_415":414,"_416":414,"_417":-5,"_418":-5,"_419":30,"_420":421,"_422":423},{"_41":249,"_43":594,"_259":596},{"_248":456,"_278":250,"_43":472,"_253":595,"_280":-5,"_281":-5,"_282":-5,"_283":-5},[],{"_261":461,"_462":285,"_597":-5},"summary",1776850808611,[600,250],"ACCOUNT","[\"ACCOUNT\",\"z6MkgYR76i3w2Xc2fcvgFJWfYjsop6YwUonDhQx3AdLmQ4BQ\"]","ssrContentHTML","

I have a pet peeve about naming fields in APIs and data structures (classes, structs, maps, dicts, whatever you call them) — I hate when fields are not nouns. I especially hate it when most fields are nouns, but some others aren't.

I probably picked it up from using Google APIs quite a bit in the past — there's this Google guideline for field naming in their Protobuf APIs, that among other things suggests to use nouns for all the fields.

There're some things to disagree with in these guidelines, but I think this rule is actually a very good one.

The simplest example of what annoys me is the very commonly used names for lifecycle timestamps: createdAt and updatedAt. So there would be a structure describing something like a user, and it would have fields like name, email, address, and those createdAt and updatedAt fields. Why is it name and not namedAs then? Why those fields in particular are not nouns?

I guess it comes from Ruby on Rails and its Active Record system, which then has spread everywhere.

But then you'd see something describing like a calendar event, and it would have fields like start and end — why not startsAt and endsAt or something like this then?

Some other examples:

The DID spec has a weird alsoKnownAs field among all the other fields that are nouns. Couldn't they call it aliases or alternateNames or something like that?
The UCAN spec that has field names like with and can which you will never know the meaning of by just looking at the data. I find that resource and ability would be much better.
GitHub Actions workflow definitions that have fields like uses and with, which I always mess up and forget what they mean. I find that action and input or something like that would be much better.

Finding a good noun for a timestamp is probably the hardest thing, so I keep following the Google's guideline (there's a different one for timestamps) and call them as {imperative}_time — createTime, updateTime, startTime and so on. Sometimes the resulting word won't be a proper English word, but I'm OK with that for the purposes of consistency.

","enableWebSigning","https://ui-with-state-machines.hyper.media","origin","homeMetadata",{"_261":609,"_610":605},"UI with State Machines","siteUrl","originHomeId",{"_278":613,"_43":614,"_253":615,"_248":-5,"_280":-5,"_281":-5,"_282":-5,"_283":-5},"z6MkhBiheioCs7btwVLUcnSCcFPdhTGGHSHpR4SHTyAobUUp","hm://z6MkhBiheioCs7btwVLUcnSCcFPdhTGGHSHpR4SHTyAobUUp",[],"meta",{"_618":619,"_651":652},"values",{"_620":621,"_623":624,"_625":626,"_627":628,"_630":631,"_632":633,"_634":635,"_637":638,"_639":640,"_641":642,"_643":644,"_645":646,"_647":648,"_649":650},"document.generationInfo.generation",[622],"bigint","dehydratedState.queries.0.state.data.document.generationInfo.generation",[622],"dehydratedState.queries.1.state.data.document.generationInfo.generation",[622],"dehydratedState.queries.1.queryKey.2",[629],"undefined","dehydratedState.queries.2.state.data.0.createTime.seconds",[622],"dehydratedState.queries.2.state.data.0.updateTime.seconds",[622],"dehydratedState.queries.2.state.data.0.sortTime",[636],"Date","dehydratedState.queries.2.state.data.0.activitySummary.latestCommentTime.seconds",[622],"dehydratedState.queries.2.state.data.0.activitySummary.latestChangeTime.seconds",[622],"dehydratedState.queries.2.state.data.0.generationInfo.generation",[622],"dehydratedState.queries.2.state.data.0.redirectInfo",[629],"dehydratedState.queries.5.state.data.document.generationInfo.generation",[622],"dehydratedState.queries.5.queryKey.2",[629],"dehydratedState.queries.6.state.data.metadata.summary",[629],"referentialEqualities",{"_620":653,"_632":654,"_641":655},[623],[639],[645],"actionData","errors"]