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.

Sign up for GitHub

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

Jump to bottom

📝 Improved documentation + added const annotations #548

Merged
merged 12 commits into from
Jan 5, 2024
Merged

📝 Improved documentation + added const annotations #548

merged 12 commits into from
Jan 5, 2024

Conversation

Guldem
Copy link
Contributor

@Guldem Guldem commented Jan 5, 2024

  • Added/Updated documentation with new Response omit functionality
  • Updated/Improved request.md documentation
  • Added dartdoc @template to shared dartdoc between class and constructor for:
    • HttpLoggingInterceptor
    • HeadersInterceptor
    • JsonConverter
    • FormUrlEncodedConverter
    • Request
    • Response
    • All annotations
  • Added const variants from all annotations. This make @Get() and @get both valid annotations.
  • Added FAQ on using Chopper and Injectable together.

@codecov Codecov
Copy link

codecov bot commented Jan 5, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (6420778) 94.17% compared to head (1979d1e) 94.17%.

Additional details and impacted files 
@@           Coverage Diff            @@
##           develop     #548   +/-   ##
========================================
  Coverage    94.17%   94.17%           
========================================
  Files           11       11           
  Lines          481      481           
========================================
  Hits           453      453           
  Misses          28       28

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

@Guldem Guldem changed the title Improved documentation + added const annotations 📝 Improved documentation + added const annotations Jan 5, 2024
techouse
techouse requested changes Jan 5, 2024
View reviewed changes
faq.md Outdated Show resolved Hide resolved
faq.md Outdated Show resolved Hide resolved
faq.md Outdated Show resolved Hide resolved
faq.md Outdated Show resolved Hide resolved
requests.md Outdated Show resolved Hide resolved
@Guldem
Copy link
Contributor Author

Guldem commented Jan 5, 2024

Intelji also tries to format code snippets which I didn't see... My bad.. bit sloppy

techouse
techouse approved these changes Jan 5, 2024
View reviewed changes
Copy link
Collaborator

@techouse techouse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Great work! ♥️

@techouse techouse merged commit 2dc868f into lejard-h:develop Jan 5, 2024
6 checks passed
techouse added a commit that referenced this pull request Jan 8, 2024
@techouse
🔖 release v7.1.0
fd67b8e 
# chopper

## 7.1.0

- #545
- #543
- #548

# chopper_generator

## 7.1.0

- #545
- #549
@techouse techouse mentioned this pull request Jan 8, 2024
Closed
techouse added a commit that referenced this pull request Jan 9, 2024
@techouse
# chopper
63d7397 
## 7.0.11

- #545
- #543
- #548

# chopper_generator

## 7.0.8

- #545
- #549
@techouse techouse mentioned this pull request Jan 9, 2024
Closed
techouse added a commit that referenced this pull request Jan 9, 2024
@techouse
# chopper
cf31fa6 
## 7.1.0

- #545
- #543
- #548

# chopper_generator

## 7.1.0

- #545
- #549
@techouse techouse mentioned this pull request Jan 9, 2024
Merged
@Guldem Guldem deleted the doc/improve_documentation branch April 6, 2024 18:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@techouse techouse techouse approved these changes

@JEuler JEuler Awaiting requested review from JEuler JEuler is a code owner

@lejard-h lejard-h Awaiting requested review from lejard-h lejard-h is a code owner

@meysam1717 meysam1717 Awaiting requested review from meysam1717 meysam1717 is a code owner

@stewemetal stewemetal Awaiting requested review from stewemetal stewemetal is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Guldem @techouse