From ddfa53e51df72125d418dd7a25092e69661908c6 Mon Sep 17 00:00:00 2001 From: Lambert Theisen <lambert.theisen@rwth-aachen.de> Date: Tue, 21 Nov 2023 18:28:36 +0100 Subject: [PATCH] Fix docu --- docs/src/lecture/3-julia_documentation.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/src/lecture/3-julia_documentation.md b/docs/src/lecture/3-julia_documentation.md index 9ec806e..d8bae69 100644 --- a/docs/src/lecture/3-julia_documentation.md +++ b/docs/src/lecture/3-julia_documentation.md @@ -19,7 +19,7 @@ In this lecture, we'll explore how to effectively document Julia code. We'll cov Here's a simple example of how to write a doc string in Julia: -```julia +````julia """ add(x, y) @@ -39,11 +39,12 @@ Compute the sum of `x` and `y`. ```julia julia> add(2, 3) 5 +``` """ function add(x::Int, y::Int) return x + y end -``` +```` This example shows how to document a function's purpose, its arguments, and provide a usage example. -- GitLab