From ae27e1f365478a6b890fbf34b73e71b677ac8685 Mon Sep 17 00:00:00 2001 From: Guspan Tanadi <36249910+guspan-tanadi@users.noreply.github.com> Date: Thu, 30 Mar 2023 15:13:47 +0700 Subject: [PATCH] Have fix bit typo README.md Writing source documentation section --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 86e577b6..19b89ac7 100644 --- a/README.md +++ b/README.md @@ -243,7 +243,7 @@ There should be json between `` 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: ``` @@ -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: