Skip to content

Commit

Permalink
Merge pull request #153 from guibranco/penify/auto_doc_190676c_5047e
Browse files Browse the repository at this point in the history
[Penify]: Documentation for commit - 190676c
  • Loading branch information
guibranco authored Aug 27, 2024
2 parents 190676c + dc232e4 commit eebbda3
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions Tests/ViaCep.Tests/ResultsFixture.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,15 @@
internal static class ResultsFixture
{
/// <summary>
/// Gets the sample results.
/// Retrieves a sample collection of <see cref="ViaCepResult"/> objects.
/// </summary>
/// <returns>ICollection&lt;ViaCepResult&gt;.</returns>
/// <returns>A collection of sample <see cref="ViaCepResult"/> instances representing address information.</returns>
/// <remarks>
/// This method creates and returns a list of <see cref="ViaCepResult"/> objects, each containing various properties such as
/// Unit, City, Complement, GIACode, IBGECode, Neighborhood, StateInitials, Street, and ZipCode.
/// The sample data includes multiple entries for the city of São Paulo, demonstrating different combinations of
/// address attributes. This can be useful for testing or demonstration purposes where mock data is needed.
/// </remarks>
public static ICollection<ViaCepResult> GetSampleResults() =>
new List<ViaCepResult>
{
Expand Down

0 comments on commit eebbda3

Please sign in to comment.