guibranco / PIX-BACEN-SDK-dotnet

🇧🇷 :bank: :gear: PIX/SPI contracts from @bacen/pix-api/
https://guibranco.github.io/PIX-BACEN-SDK-dotnet/
MIT License
20 stars 7 forks source link

[Penify]: Documentation for commit - a9df1f1 #124

Closed penify-dev[bot] closed 2 weeks ago

penify-dev[bot] commented 2 weeks ago

This PR focuses exclusively on updating and refining the documentation throughout the codebase. There are no functional changes to the code itself.

Changes: Src/PIXBacen/ChargeFilter.cs Src/PIXBacen/CobrancaPayloadList.cs Src/PIXBacen/IPixClient.cs Src/PIXBacen/Models/Calendario.cs Src/PIXBacen/Models/Devolucao.cs Src/PIXBacen/Models/Horario.cs Src/PIXBacen/Models/InfoAdicional.cs Src/PIXBacen/Models/Loc.cs Src/PIXBacen/Models/Pessoa.cs Src/PIXBacen/Models/Pix.cs Src/PIXBacen/Models/Valor.cs Src/PIXBacen/Paginacao.cs Src/PIXBacen/Parametros.cs Src/PIXBacen/PixClient.cs Tests/PixBacen.Tests/UnitTest1.cs

🙏 Request: Please review the changes to ensure that the documentation is clear, accurate, and adheres to your project's standards. Any feedback regarding areas that might still need clarification or additional details would be highly appreciated. You can also raise the request on the Penify Community or mail us at support@penify.dev

AppVeyorBot commented 2 weeks ago

:x: Build PIX-BACEN-SDK-dotnet 1.1.358 failed (commit https://github.com/guibranco/PIX-BACEN-SDK-dotnet/commit/bef7e481fe by @penify-dev[bot])

AppVeyorBot commented 2 weeks ago

:x: Build PIX-BACEN-SDK-dotnet 1.1.364 failed (commit https://github.com/guibranco/PIX-BACEN-SDK-dotnet/commit/6a45640d6b by @gstraccini[bot])

guibranco commented 2 weeks ago

@gstraccini csharpier

gstraccini[bot] commented 2 weeks ago

Running CSharpier on this branch! :wrench:

gstraccini[bot] commented 2 weeks ago

:white_check_mark: CSharpier result:

Error ./Src/PIXBacen/PixClient.cs - Failed to compile so was not formatted.
  (166,9): error CS1028: Unexpected preprocessor directive
Error ./Tests/PixBacen.Tests/UnitTest1.cs - Was not formatted.
  ----------------------------- Expected: Around Line 11 -----------------------------
      {
          /// <summary>
          /// Tests the GetChargePayloadAsync method of the PixClient class.
  ----------------------------- Actual: Around Line 11 -----------------------------
      {

          /// <summary>
gstraccini[bot] commented 2 weeks ago

:x: CSharpier failed!

codacy-production[bot] commented 2 weeks ago

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
:white_check_mark: +0.00% (target: -1.00%) :white_check_mark:
Coverage variation details | | Coverable lines | Covered lines | Coverage | | ------------- | ------------- | ------------- | ------------- | | Common ancestor commit (1eabc7dd626e839e913fe4185eaba0ffe2b8e306) | 75 | 1 | 1.33% | | | Head commit (efaa9f462361c8d643463fdc07e9e81cfe1319c9) | 75 (+0) | 1 (+0) | 1.33% (**+0.00%**) | **Coverage variation** is the difference between the coverage for the head and common ancestor commits of the pull request branch: ` - `
Diff coverage details | | Coverable lines | Covered lines | Diff coverage | | ------------- | ------------- | ------------- | ------------- | | Pull request (#124) | 0 | 0 | **∅ (not applicable)** | **Diff coverage** is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: `/ * 100%`

See your quality gate settings    Change summary preferences

Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more

guibranco commented 2 weeks ago

@gstraccini csharpier

gstraccini[bot] commented 2 weeks ago

Running CSharpier on this branch! :wrench:

gstraccini[bot] commented 2 weeks ago

:white_check_mark: CSharpier result:

Error ./Tests/PixBacen.Tests/UnitTest1.cs - Was not formatted.
  ----------------------------- Expected: Around Line 11 -----------------------------
      {
          /// <summary>
          /// Tests the GetChargePayloadAsync method of the PixClient class.
  ----------------------------- Actual: Around Line 11 -----------------------------
      {

          /// <summary>

Error ./Src/PIXBacen/PixClient.cs - Was not formatted.
  ----------------------------- Expected: Around Line 9 -----------------------------
      {
          /// <summary>
          /// Asynchronously retrieves the charge payload using the provided access token.
  ----------------------------- Actual: Around Line 9 -----------------------------
      {

          /// <summary>
github-actions[bot] commented 2 weeks ago

Infisical secrets check: :white_check_mark: No secrets leaked!

Scan results:

3:40PM INF scanning for exposed secrets...
3:40PM INF 149 commits scanned.
3:40PM INF scan completed in 102ms
3:40PM INF no leaks found
sonarcloud[bot] commented 2 weeks ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

AppVeyorBot commented 2 weeks ago

:white_check_mark: Build PIX-BACEN-SDK-dotnet 1.1.368 completed (commit https://github.com/guibranco/PIX-BACEN-SDK-dotnet/commit/d1c82f93bb by @gstraccini[bot])

codecov[bot] commented 2 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 1.33%. Comparing base (1eabc7d) to head (efaa9f4). Report is 1 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #124 +/- ## ===================================== Coverage 1.33% 1.33% ===================================== Files 17 17 Lines 75 75 ===================================== Hits 1 1 Misses 74 74 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.