The Ruby on Rails guides use "please" when suggesting other resource to read or best practices to follow. For example: https://guides.rubyonrails.org/autoloading_and_reloading_constants.html
I've not seen this docs convention before. I certainly see the appeal for describing best practices: "your collaborators will appreciate it!"
miniblog.
Related Posts
It's such a tiny thing, but I really like the Python or Lisp convention of putting the doc string inside the definition.
I find I write the signature first anyway, and figure out what I want to call my function, before I know how I want to describe it.
3
I like the lisp convention of 'defvar' (define a variable), 'defmacro' (define a macro). 'defun' feels a little weird though -- shouldn't it have been 'deffun'?
1
"Conventional commits" https://www.conventionalcommits.org/ encourages a convention of prefixing your commit messages with e.g. "fix: problem", "feat: button".
I've been playing with it, and it's really nice to easily see what features/fixes happened since the last release.
