Fix a few YARD example rendering issues

This commit is contained in:
Wilson Silva 2023-11-20 21:32:55 +07:00
parent 8bc6b84f6f
commit c064a8d5f0
No known key found for this signature in database
GPG Key ID: 65135F94E23F82C8
7 changed files with 34 additions and 23 deletions

View File

@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.1.1/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Fixed
- Fixed YARD example rendering issues in `InvalidKeyFormatError#initialize`, `InvalidKeyLengthError#initialize`,
`InvalidKeyTypeError#initialize`, `Event#initialize`, `EncryptedDirectMessage#initialize` and `Filter#to_h`
## [0.5.0] 2023-11-20
### Added
@ -82,6 +89,7 @@ principles of immutability and was a major source of internal complexity as I ne
- Initial release
[unreleased]: https://github.com/wilsonsilva/nostr/compare/v0.5.0...HEAD
[0.5.0]: https://github.com/wilsonsilva/nostr/compare/v0.4.0...v0.5.0
[0.4.0]: https://github.com/wilsonsilva/nostr/compare/v0.3.0...v0.4.0
[0.3.0]: https://github.com/wilsonsilva/nostr/compare/v0.2.0...v0.3.0

View File

@ -9,7 +9,7 @@ module Nostr
# Initializes the error
#
# @example
# InvalidKeyFormatError.new('private'')
# InvalidKeyFormatError.new('private')
#
# @param [String] key_kind The kind of key that is invalid (public or private)
#

View File

@ -9,7 +9,7 @@ module Nostr
# Initializes the error
#
# @example
# InvalidKeyLengthError.new('private'')
# InvalidKeyLengthError.new('private')
#
# @param [String] key_kind The kind of key that is invalid (public or private)
#

View File

@ -9,7 +9,7 @@ module Nostr
# Initializes the error
#
# @example
# InvalidKeyTypeError.new('private'')
# InvalidKeyTypeError.new('private')
#
# @param [String] key_kind The kind of key that is invalid (public or private)
#

View File

@ -133,13 +133,16 @@ module Nostr
# @api public
#
# @example
# filter.to_h # => {:ids=>["c24881c305c5cfb7c1168be7e9b0e150"],
# :authors=>["000000001c5c45196786e79f83d21fe801549fdc98e2c26f96dcef068a5dbcd7"],
# :kinds=>[0, 1, 2],
# :"#e"=>["7bdb422f254194ae4bb86d354c0bd5a888fce233ffc77dceb3e844ceec1fcfb2"],
# :"#p"=>["000000001c5c45196786e79f83d21fe801549fdc98e2c26f96dcef068a5dbcd7"],
# :since=>1230981305,
# :until=>1292190341}
# filter.to_h # =>
# {
# ids: ['c24881c305c5cfb7c1168be7e9b0e150'],
# authors: ['000000001c5c45196786e79f83d21fe801549fdc98e2c26f96dcef068a5dbcd7'],
# kinds: [0, 1, 2],
# '#e': ['7bdb422f254194ae4bb86d354c0bd5a888fce233ffc77dceb3e844ceec1fcfb2'],
# '#p': ['000000001c5c45196786e79f83d21fe801549fdc98e2c26f96dcef068a5dbcd7'],
# since: 1230981305,
# until: 1292190341
# }
#
# @return [Hash] The filter as a hash.
#