Skip to content

Commit bfe3994

Browse files
committed
Update comments.md
Record another suggestion that I jsut made to someone in chat.
1 parent c7d4f30 commit bfe3994

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

general/development/abc/comments.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,11 @@ useful?
2525
That is what really needs to be explained. For example, if something is being passed as a string,
2626
what formats will work?
2727
- An example can be worth a dozen words, as you can see in the good example below :-)
28+
- One way to give an example that is sometimes effective is to [link a good example elsewhere in the
29+
code](https://github.com/moodle/moodle/blob/f747c15cbf1c1c963a9592a73b167b969ec33d75/public/lib/portfolio/plugin.php#L404)
30+
(← see, I did it just there), perhaps using `{@see ...}`.
31+
As another example (that could be improved), the comments on some of the methods mention particular
32+
standard question types which give good or interesting example of how to override that method.
2833

2934
<InvalidExample>
3035

0 commit comments

Comments
 (0)