We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent c7d4f30 commit bfe3994Copy full SHA for bfe3994
1 file changed
general/development/abc/comments.md
@@ -25,6 +25,11 @@ useful?
25
That is what really needs to be explained. For example, if something is being passed as a string,
26
what formats will work?
27
- 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.
33
34
<InvalidExample>
35
0 commit comments