Skip to content

Commit cf62b36

Browse files
committed
Technical writing slides: Update URLs
1 parent 7cabcd7 commit cf62b36

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

04_documentation/technical_writing_slides.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -419,7 +419,7 @@ Android's ActionBar class:
419419

420420
**Long description**: how to use, key features, best practices, ...
421421

422-
Example: [preCICE API](https://precice.org/doxygen/main/classprecice_1_1SolverInterface.html)
422+
Example: [preCICE API](https://precice.org/doxygen/main/classprecice_1_1Participant.html)
423423

424424
---
425425

@@ -461,7 +461,7 @@ Example: [preCICE API](https://precice.org/doxygen/main/classprecice_1_1SolverIn
461461
- *The bird specified by the given ID.*
462462
- *True if the bird is in the sanctuary; false otherwise.*
463463

464-
Example: [preCICE API](https://precice.org/doxygen/main/classprecice_1_1SolverInterface.html)
464+
Example: [preCICE API](https://precice.org/doxygen/main/classprecice_1_1Participant.html)
465465

466466
---
467467

@@ -483,3 +483,5 @@ Example: [preCICE API](https://precice.org/doxygen/main/classprecice_1_1SolverIn
483483
- [I'd Rather Be Writing blog](https://idratherbewriting.com/)
484484
- [Google developer documentation style guide](https://developers.google.com/style)
485485
- [Section on API documentation](https://developers.google.com/style/api-reference-comments)
486+
- [Kubernetes documentation style guide](https://kubernetes.io/docs/contribute/style/style-guide/#avoid-words-that-assume-a-specific-level-of-understanding)
487+
- [Ten simple rules for documenting scientific software](https://doi.org/10.1371/journal.pcbi.1006561)

0 commit comments

Comments
 (0)