Skip to content

Commit de9d07b

Browse files
committed
Add better documentation to bake tasks.
1 parent 8cf75ec commit de9d07b

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

bake/localhost.rb

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ def initialize(...)
1010
end
1111

1212
# List all local authorities.
13+
#
14+
# @returns [Array(Hash)] The certificate and key paths, and the expiry date.
1315
def list
1416
Localhost::Authority.list.map do |authority|
1517
{
@@ -20,6 +22,10 @@ def list
2022
end
2123
end
2224

25+
# Fetch a local authority by hostname. If the authority does not exist, it will be created.
26+
#
27+
# @parameter hostname [String] The hostname to fetch.
28+
# @returns [Hash] The certificate and key paths, and the expiry date.
2329
def fetch(hostname)
2430
if authority = Localhost::Authority.fetch(hostname)
2531
return {

0 commit comments

Comments
 (0)