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/) 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). 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 ## [0.5.0] 2023-11-20
### Added ### Added
@ -82,6 +89,7 @@ principles of immutability and was a major source of internal complexity as I ne
- Initial release - 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.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.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 [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 # Initializes the error
# #
# @example # @example
# InvalidKeyFormatError.new('private'') # InvalidKeyFormatError.new('private')
# #
# @param [String] key_kind The kind of key that is invalid (public or 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 # Initializes the error
# #
# @example # @example
# InvalidKeyLengthError.new('private'') # InvalidKeyLengthError.new('private')
# #
# @param [String] key_kind The kind of key that is invalid (public or 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 # Initializes the error
# #
# @example # @example
# InvalidKeyTypeError.new('private'') # InvalidKeyTypeError.new('private')
# #
# @param [String] key_kind The kind of key that is invalid (public or private) # @param [String] key_kind The kind of key that is invalid (public or private)
# #

View File

@ -100,15 +100,15 @@ module Nostr
# #
# @example Instantiating a new event # @example Instantiating a new event
# Nostr::Event.new( # Nostr::Event.new(
# id: 'ccf9fdf3e1466d7c20969c71ec98defcf5f54aee088513e1b73ccb7bd770d460', # id: 'ccf9fdf3e1466d7c20969c71ec98defcf5f54aee088513e1b73ccb7bd770d460',
# pubkey: '48df4af6e240ac5f7c5de89bf5941b249880be0e87d03685b178ccb1a315f52e', # pubkey: '48df4af6e240ac5f7c5de89bf5941b249880be0e87d03685b178ccb1a315f52e',
# created_at: 1230981305, # created_at: 1230981305,
# kind: 1, # kind: 1,
# tags: [], # tags: [],
# content: 'Your feedback is appreciated, now pay $8', # content: 'Your feedback is appreciated, now pay $8',
# sig: '123ac2923b792ce730b3da34f16155470ab13c8f97f9c53eaeb334f1fb3a5dc9a7f643 # sig: '123ac2923b792ce730b3da34f16155470ab13c8f97f9c53eaeb334f1fb3a5dc9a7f643
# 937c6d6e9855477638f5655c5d89c9aa5501ea9b578a66aced4f1cd7b3' # 937c6d6e9855477638f5655c5d89c9aa5501ea9b578a66aced4f1cd7b3'
# ) # )
# #
# @param id [String|nil] 32-bytes sha256 of the the serialized event data. # @param id [String|nil] 32-bytes sha256 of the the serialized event data.
# @param sig [String|nil] 64-bytes signature of the sha256 hash of the serialized event data, which is # @param sig [String|nil] 64-bytes signature of the sha256 hash of the serialized event data, which is

View File

@ -11,19 +11,19 @@ module Nostr
# @api public # @api public
# #
# @example Instantiating a new encrypted direct message # @example Instantiating a new encrypted direct message
# Nostr::Events::EncryptedDirectMessage.new( # Nostr::Events::EncryptedDirectMessage.new(
# sender_private_key: 'ccf9fdf3e1466d7c20969c71ec98defcf5f54aee088513e1b73ccb7bd770d460', # sender_private_key: 'ccf9fdf3e1466d7c20969c71ec98defcf5f54aee088513e1b73ccb7bd770d460',
# recipient_public_key: '48df4af6e240ac5f7c5de89bf5941b249880be0e87d03685b178ccb1a315f52e', # recipient_public_key: '48df4af6e240ac5f7c5de89bf5941b249880be0e87d03685b178ccb1a315f52e',
# plain_text: 'Your feedback is appreciated, now pay $8', # plain_text: 'Your feedback is appreciated, now pay $8',
# ) # )
# #
# @example Instantiating a new encrypted direct message that references a previous direct message # @example Instantiating a new encrypted direct message that references a previous direct message
# Nostr::Events::EncryptedDirectMessage.new( # Nostr::Events::EncryptedDirectMessage.new(
# sender_private_key: 'ccf9fdf3e1466d7c20969c71ec98defcf5f54aee088513e1b73ccb7bd770d460', # sender_private_key: 'ccf9fdf3e1466d7c20969c71ec98defcf5f54aee088513e1b73ccb7bd770d460',
# recipient_public_key: '48df4af6e240ac5f7c5de89bf5941b249880be0e87d03685b178ccb1a315f52e', # recipient_public_key: '48df4af6e240ac5f7c5de89bf5941b249880be0e87d03685b178ccb1a315f52e',
# plain_text: 'Your feedback is appreciated, now pay $8', # plain_text: 'Your feedback is appreciated, now pay $8',
# previous_direct_message: 'ccf9fdf3e1466d7c20969c71ec98defcf5f54aee088513e1b73ccb7bd770d460' # previous_direct_message: 'ccf9fdf3e1466d7c20969c71ec98defcf5f54aee088513e1b73ccb7bd770d460'
# ) # )
# #
# @param plain_text [String] The +content+ of the encrypted message. # @param plain_text [String] The +content+ of the encrypted message.
# @param sender_private_key [PrivateKey] 32-bytes hex-encoded private key of the message's author. # @param sender_private_key [PrivateKey] 32-bytes hex-encoded private key of the message's author.

View File

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