Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOP-13219] Improve documentation #20

Merged
merged 1 commit into from
Feb 20, 2024
Merged

[DOP-13219] Improve documentation #20

merged 1 commit into from
Feb 20, 2024

Conversation

dolfinus
Copy link
Member

@dolfinus dolfinus commented Feb 20, 2024

Change Summary

  • Fixed missing imports in client methods documentation

  • Fixed HorizonClientSync example

  • Replaced .. code-block:: python + assert ... with doctest-like >>> syntax. It should be more user-friendly (in theory), and it is also more IDE-friendly:
    изображение

  • Updated sphinx-copybutton config to avoid copying example outputs

  • Fixed changelog validation CI workflow

Compare old docs with new ones

Related issue number

Checklist

  • Commit message and PR title is comprehensive
  • Keep the change as small as possible
  • Unit and integration tests for the changes exist
  • Tests pass on CI and coverage does not decrease
  • Documentation reflects the changes where applicable
  • docs/changelog/next_release/<pull request or issue id>.<change type>.rst file added describing change
    (see CONTRIBUTING.rst for details.)
  • My PR is ready to review.

Copy link

codecov bot commented Feb 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (7ec0ce5) 89.38% compared to head (6415975) 89.38%.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop      #20   +/-   ##
========================================
  Coverage    89.38%   89.38%           
========================================
  Files          103      103           
  Lines         1959     1959           
  Branches       182      182           
========================================
  Hits          1751     1751           
  Misses         162      162           
  Partials        46       46           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@dolfinus dolfinus marked this pull request as ready for review February 20, 2024 10:59
@dolfinus dolfinus merged commit 53821b5 into develop Feb 20, 2024
16 checks passed
@dolfinus dolfinus deleted the feature/DOP-13219 branch February 20, 2024 11:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants