Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
SustainableSoftwareEngineering.jl
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Theisen, Lambert
SustainableSoftwareEngineering.jl
Commits
ddfa53e5
Commit
ddfa53e5
authored
1 year ago
by
Theisen, Lambert
🔥
Browse files
Options
Downloads
Patches
Plain Diff
Fix docu
parent
54e23922
Branches
Branches containing commit
No related tags found
No related merge requests found
Pipeline
#1990
passed
1 year ago
Stage: deploy
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/src/lecture/3-julia_documentation.md
+3
-2
3 additions, 2 deletions
docs/src/lecture/3-julia_documentation.md
with
3 additions
and
2 deletions
docs/src/lecture/3-julia_documentation.md
+
3
−
2
View file @
ddfa53e5
...
@@ -19,7 +19,7 @@ In this lecture, we'll explore how to effectively document Julia code. We'll cov
...
@@ -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:
Here's a simple example of how to write a doc string in Julia:
```
julia
```
`
julia
"""
"""
add(x, y)
add(x, y)
...
@@ -39,11 +39,12 @@ Compute the sum of `x` and `y`.
...
@@ -39,11 +39,12 @@ Compute the sum of `x` and `y`.
```julia
```julia
julia> add(2, 3)
julia> add(2, 3)
5
5
```
"""
"""
function
add
(
x
::
Int
,
y
::
Int
)
function
add
(
x
::
Int
,
y
::
Int
)
return
x
+
y
return
x
+
y
end
end
```
```
`
This example shows how to document a function's purpose, its arguments, and provide a usage example.
This example shows how to document a function's purpose, its arguments, and provide a usage example.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment