Improve Request documentation and add delete method with payload

guibranco / pancake

🧰 🛠️ Pancake project - toolkit for PHP projects

https://guibranco.github.io/pancake/

MIT License

3 stars 1 forks source link

Improve Request documentation and add delete method with payload #94

Closed guibranco closed 7 months ago

guibranco commented 7 months ago

Before the change?

Add Request->delete capability to receive a payload.
Improve Request class documentation.

After the change?

A more accurate documentation will be in place.
A new optional parameter for the delete method will be available.

Pull request checklist

[X] Tests for the changes have been added (for bug fixes/features)
[X] Docs have been reviewed and added/updated if needed (for bug fixes/features)

Does this introduce a breaking change?

[ ] Yes
[X] No

deepsource-io[bot] commented 7 months ago

Here's the code health analysis summary for commits 34c9d7b..ef55d79. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Summary	Link
Test coverage	✅ Success		View Check ↗
SQL	✅ Success		View Check ↗
Secrets	✅ Success		View Check ↗
PHP	❌ Failure	❗ 11 occurences introduced	View Check ↗
Docker	✅ Success		View Check ↗

Code Coverage Report

Metric	Aggregate	Php
Branch Coverage	100%	100%
Composite Coverage	98.8% (down 1.2% from `main`)	98.8% (down 1.2% from `main`)
Line Coverage	98.8% (down 1.2% from `main`)	98.8% (down 1.2% from `main`)

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

codacy-production[bot] commented 7 months ago

Coverage summary from Codacy

Coverage variation	Diff coverage
:x: -1.16% (target: -1.00%)	:white_check_mark: 50.00%

| | Coverable lines | Covered lines | Coverage | | ------------- | ------------- | ------------- | ------------- | | Common ancestor commit (34c9d7b04b30ef9fe0fc35de32d644b537477e08) | 84 | 84 | 100.00% | | | Head commit (ef55d791cafb2c79c68baebfd791fc31664b3787) | 86 (+2) | 85 (+1) | 98.84% (**-1.16%**) | **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 (#94) | 2 | 1 | **50.00%** | **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%`