Skip to content

Commit ad2c50c

Browse files
MxrconMxrcon
committed
improving documenation
1 parent 9005763 commit ad2c50c

File tree

4 files changed

+100
-66
lines changed

4 files changed

+100
-66
lines changed

‎BioNameGenerator/Public/Get-RandomPhrase.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Function Get-RandomPhrase {
22
<#
33
.SYNOPSIS
4-
This functions handles the request for random Keyword using the function "Get-KeywordFromDatabase"
4+
This function Generates 2 or 3 random words and concatenate them with a delimiter
55
.DESCRIPTION
66
Returns one or more random generated words separated by a delimiter
77
.EXAMPLE

‎docs/en-US/Dicionaries.md

Lines changed: 3 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -5,54 +5,13 @@ online version:
55
schema: 2.0.0
66
---
77

8-
# Get-HelloWorld
8+
# Dictionaries
99

1010
## SYNOPSIS
11-
Returns Hello world
1211

13-
## SYNTAX
14-
15-
```
16-
Get-HelloWorld [[-Value] <String>] [<CommonParameters>]
17-
```
12+
SQLite database used by the Module to store the keywords
1813

1914
## DESCRIPTION
20-
Returns Hello world
21-
22-
## EXAMPLES
23-
24-
### EXAMPLE 1
25-
```
26-
Get-HelloWorld
27-
```
28-
29-
Runs the command
30-
31-
## PARAMETERS
32-
33-
### -Value
34-
Parameter description can go here or above in format: .PARAMETER \<Parameter-Name\>
35-
36-
```yaml
37-
Type: String
38-
Parameter Sets: (All)
39-
Aliases:
40-
41-
Required: False
42-
Position: 1
43-
Default value: GetHelloWorld
44-
Accept pipeline input: False
45-
Accept wildcard characters: False
46-
```
47-
48-
### CommonParameters
49-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
50-
51-
## INPUTS
52-
53-
## OUTPUTS
5415

55-
### System.String
56-
## NOTES
16+
Contains several tables that are acessed by the private function`Get-KeywordFromDatabase`
5717

58-
## RELATED LINKS

‎docs/en-US/Get-RandomKeyword.md

Lines changed: 41 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,33 +5,62 @@ online version:
55
schema: 2.0.0
66
---
77

8-
# Get-HelloWorld
8+
# Get-RandomKeyword
99

1010
## SYNOPSIS
11-
Returns Hello world
11+
This functions handles the request for random Keyword based using the function "Get-KeywordFromDatabase"
1212

1313
## SYNTAX
1414

1515
```
16-
Get-HelloWorld [[-Value] <String>] [<CommonParameters>]
16+
Get-RandomKeyword [[-Dictionary] <String>] [<CommonParameters>]
1717
```
1818

1919
## DESCRIPTION
20-
Returns Hello world
20+
Returns a random Keyword from one of the following dictionaries: ["28kAdj",
21+
"5kColors","Aminoacids","Animals","Books",
22+
"Brazilian","Colors","Comp","Compounds","Elements",
23+
"Fields","Generas","Lab","Metals","NF-Adj",
24+
"NF-Names","Nobel","Nucleic","RPG","Species"]
25+
2126

2227
## EXAMPLES
2328

2429
### EXAMPLE 1
25-
```
26-
Get-HelloWorld
30+
```powershell
31+
Get-RandomKeyword -Dicitionary Nobel
2732
```
2833

29-
Runs the command
34+
Returns a random Nobel winner
3035

3136
## PARAMETERS
3237

33-
### -Value
34-
Parameter description can go here or above in format: .PARAMETER \<Parameter-Name\>
38+
### -Dictionary
39+
40+
Specifies wich Dictiory use for finding random words
41+
42+
Options:
43+
DictName Description
44+
- 28kAdj - 28.000 Adjectives
45+
- 5kColors - 5.000 Color names
46+
- Aminoacids - Aminoacids names
47+
- Animals - Animals names
48+
- Books - Important Biological Books
49+
- Brazilian - Important Brazilian Scientists
50+
- Colors - HTML5 Named Colors
51+
- Comp - Computation related Keyworks
52+
- Compounds - Chemical compounds name-parts
53+
- Elements - Periodic table elements
54+
- Fields - Fields Medal Laureates
55+
- Generas - Bacterial Generas
56+
- Lab - Laboratory related keywords
57+
- Metals - Metals and Alloys names
58+
- NF-Adj - Adjective List from Nextflow run ID
59+
- NF-Names - Important Scientists from Newxtflow run ID
60+
- Nobel - Nobel Laureates
61+
- Nucleic - Nucleic Acid Bases
62+
- RPG - Role Playing Games related Keywords
63+
- Species - Bacterial Species
3564

3665
```yaml
3766
Type: String
@@ -40,19 +69,20 @@ Aliases:
4069

4170
Required: False
4271
Position: 1
43-
Default value: GetHelloWorld
72+
Default value: Aminoacid
4473
Accept pipeline input: False
4574
Accept wildcard characters: False
4675
```
4776
4877
### CommonParameters
4978
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
5079
51-
## INPUTS
5280
5381
## OUTPUTS
5482
5583
### System.String
84+
A random string from one of the Dictionaries
85+
5686
## NOTES
5787
5888
## RELATED LINKS

‎docs/en-US/Get-RandomPhrase.md

Lines changed: 55 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,33 +5,32 @@ online version:
55
schema: 2.0.0
66
---
77

8-
# Get-HelloWorld
8+
# Get-RandomPhrase
99

1010
## SYNOPSIS
11-
Returns Hello world
11+
This function Generates 2 or 3 random words and concatenate them with a delimiter
1212

1313
## SYNTAX
1414

1515
```
16-
Get-HelloWorld [[-Value] <String>] [<CommonParameters>]
16+
Get-RandomPhrase [[-Start] <String>] [[-Middle] <String>] [[-End] <String>] [<CommonParameters>]
1717
```
1818

1919
## DESCRIPTION
20-
Returns Hello world
21-
20+
Returns one or more random generated words separated by a delimiter
2221
## EXAMPLES
2322

2423
### EXAMPLE 1
2524
```
26-
Get-HelloWorld
25+
Get-RandomPhrase -Start Metals -Middle Nobel -End Species -Delimiter "-"
2726
```
2827

29-
Runs the command
28+
Returns a random phrase joined by a delimiter, exemple output: `Flevorium-Koshiba-antibiotica`
3029

3130
## PARAMETERS
3231

33-
### -Value
34-
Parameter description can go here or above in format: .PARAMETER \<Parameter-Name\>
32+
### -Start
33+
Specifies the dictionary to be used for the first word, can be one of the dicitionaries or None
3534

3635
```yaml
3736
Type: String
@@ -40,19 +39,65 @@ Aliases:
4039

4140
Required: False
4241
Position: 1
43-
Default value: GetHelloWorld
42+
Default value: Aminoacid
4443
Accept pipeline input: False
4544
Accept wildcard characters: False
4645
```
4746
47+
### -Middle
48+
Specifies the dictionary to be used for the middle word, can be one of the dicitionaries or None
49+
50+
```yaml
51+
Type: String
52+
Parameter Sets: (All)
53+
Aliases:
54+
55+
Required: False
56+
Position: 2
57+
Default value: None
58+
Accept pipeline input: False
59+
Accept wildcard characters: False
60+
```
61+
62+
### -End
63+
Specifies the dictionary to be used for the Last word, can be one of the dicitionaries or None
64+
65+
```yaml
66+
Type: String
67+
Parameter Sets: (All)
68+
Aliases:
69+
70+
Required: False
71+
Position: 3
72+
Default value: Generas
73+
Accept pipeline input: False
74+
Accept wildcard characters: False
75+
```
4876
### CommonParameters
4977
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
5078
79+
80+
### -Delimiter
81+
Specifies which string will be used as delimiter for the Phrase
82+
83+
```yaml
84+
Type: String
85+
Parameter Sets: (All)
86+
Aliases:
87+
88+
Required: False
89+
Position: 4
90+
Default value: "_"
91+
Accept pipeline input: False
92+
Accept wildcard characters: False
93+
94+
```
5195
## INPUTS
5296
5397
## OUTPUTS
5498
5599
### System.String
100+
A random string Joined by the specified Delimiter.
56101
## NOTES
57102
58103
## RELATED LINKS

0 commit comments

Comments
 (0)