From c46554a3e5cdb065028552dbcb632a915ba2ac42 Mon Sep 17 00:00:00 2001 From: lfenzo Date: Thu, 11 Apr 2024 18:49:38 -0300 Subject: [PATCH] doc(street): small additions for the new street generator functions --- src/providers/localization.jl | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/src/providers/localization.jl b/src/providers/localization.jl index 9d3e41a..be7ed9d 100644 --- a/src/providers/localization.jl +++ b/src/providers/localization.jl @@ -367,10 +367,13 @@ end street(options::Vector{<:AbstractString}, n::Integer; kws...) street(mask::Vector{<:AbstractString}; kws...) -Generate `n` street names. +Generate `n` street names. Note that for option and mask-based generation the only valid options +to provide are `country_code`s. -# Kwargs -- `locale::Vector{String}`: locale(s) from which entries are sampled. If no `locale` is provided, the current session locale is used. +# Parameters +- `n::Integer = 1`: number of street names entries to generate. +- `options::Vector{<:AbstractString}`: vector with with options restricting the possible values generated. +- `mask::Vector{<:AbstractString}`: mask vector with element-wise option restrictions. """ function street(n::Integer = 1; locale = session_locale()) streets = String[]