restful-api-guidelines icon indicating copy to clipboard operation
restful-api-guidelines copied to clipboard

Add suggested changes from API guild discussion

Open SmilyOrg opened this issue 2 years ago • 5 comments

I took some liberties on the formatting/wording, but mostly it's as discussed in the internal doc.

SmilyOrg avatar Nov 28 '23 16:11 SmilyOrg

I'm a bit hesitant to approve this, because the pull request majorly splits up the dense description from before into 4 subsections without providing additional clarification that wasn't clear from the before context. In my opinion the deeper nesting is not preferable here.

The wording improvements are fine and could be added to the before structure too.

tkrop avatar Nov 29 '23 10:11 tkrop

I'm a bit hesitant to approve this, because the pull request majorly splits up the dense description from before into 4 subsections without providing additional clarification that wasn't clear from the before context. In my opinion the deeper nesting is not preferable here.

The wording improvements are fine and could be added to the before structure too.

You're right, looking at it again it seems a bit too wordy. However, the previous dense description seemed a bit too overloaded, so there was a lot to interpret. Maybe there's a good structure somewhere in the middle? I'll have to take another look :)

Either way, I applied the suggestions, thanks!

SmilyOrg avatar Dec 11 '23 15:12 SmilyOrg

👍

tfrauenstein avatar Jan 23 '24 13:01 tfrauenstein

@tkrop this is ready for another look. Most of your comments were actually on a diff that was from a non-ideal merge, so I opened #795 for those. The diff should be cleaner now.

SmilyOrg avatar Feb 08 '24 13:02 SmilyOrg

👍

tkrop avatar Feb 21 '24 18:02 tkrop

@ePaul I added your suggestion, please check again!

SmilyOrg avatar Feb 27 '24 12:02 SmilyOrg

:+1:

SmilyOrg avatar Feb 29 '24 12:02 SmilyOrg

:+1:

ePaul avatar Feb 29 '24 14:02 ePaul