Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove line about @author tag in assignments #206

Merged
merged 1 commit into from
Feb 18, 2025
Merged

Remove line about @author tag in assignments #206

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions src/chapters/basics/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,7 @@ let rec sum lst = ...
be rendered in HTML as `typewriter font` rather than the regular font.

Also like Javadoc, OCamldoc supports *documentation tags*, such as `@author`,
`@deprecated`, `@param`, `@return`, etc. For example, in the first line of most
programming assignments, we ask you to complete a comment like this:

```ocaml
(** @author Your Name (your netid) *)
```
`@deprecated`, `@param`, `@return`, etc.

For the full range of possible markup inside a OCamldoc comment, see
[the OCamldoc manual](https://ocaml.org/manual/ocamldoc.html).
Expand Down