paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 29 Packages Projects Releases Wiki Activity

Update the docs

Browse Source 
Signed-off-by: Saksham Sharma <sakshamsharma630@gmail.com>
This commit is contained in:
Saksham Sharma
2022-02-21 14:59:56 +05:30
parent 7ee2f47049
commit e7d2599d35
6 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
STYLE.md
+2 -2
View File
@@ -131,7 +131,7 @@ We use [API Extractor](https://api-extractor.com/pages/overview/demo_docs/) to g
The doc comments are of the good old `/** ... */` format, with tags of the format `@<tag>` used to mark various things. The [TSDoc website](https://tsdoc.org/) has a good index of all available tags.
There are a few things to pay attention to make the documentation show up in a nice way on the website...
There are a few things to pay attention to to make the documentation show up in a nice way on the website...
## Declare exported functions using the `function` keyword
@@ -163,7 +163,7 @@ If the parameters of a function are destructed in the parameter list, they will
![image](https://user-images.githubusercontent.com/4984472/133117011-3e6cb6da-40dd-450e-8d33-51bdcf412e08.png)
Instead prefer to use a single parameter variable and then move the destructuring into the function body instead, which will look much nicer:
Instead prefer to use a single parameter variable and then move the destructuring into the function body, which will look much nicer:
![image](https://user-images.githubusercontent.com/4984472/133120542-d648de43-5495-43a8-b532-f5e6f6ab736e.png)