Skip to content

Commit

Permalink
Have fix bit typo README.md (#364)
Browse files Browse the repository at this point in the history
Writing source documentation section
  • Loading branch information
guspan-tanadi authored Apr 18, 2023
1 parent e7ebd5f commit 3f6a2fd
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ There should be json between `<literalinclude>` open & close tags.
### Writing source documentation

Arguments of a function/class/method should be defined with the `Args:` (or `Arguments:` or `Parameters:`) prefix, followed by a line return and
an indentation. The argument should be followed by its type, with its shape if it is a tensor, a colon and its
an indentation. The argument should be followed by its type, with its shape if it is a tensor, a colon, and its
description:

```
Expand All @@ -252,7 +252,7 @@ description:
```

If the description is too long to fit in one line, another indentation is necessary before writing the description
after th argument.
after the argument.

Here's an example showcasing everything so far:

Expand Down

0 comments on commit 3f6a2fd

Please sign in to comment.