Skip to content

Conversation

@RUNQILIU-123
Copy link

A tutorial review of the tutorial has been done.The code in this tutorial has been run to ensure that it works and outputs the results.

Checks done:
Tested in latest Chrome
Tested in latest Firefox
npm run build
npm run preview

Code Checks:
Checked C#
Checked C++
Checked Python

Code output results:
C++ examples:
Example 1: GET single resource
image
Example 2: GET all resources
image
Example 3: POST resource
image
C# Top-Level Examples
Example 1: GET single resource
image
Example 2: GET all resources
image
Example 3: POST resource
image
C# OOP Examples
Example 1: GET single resource
image
Example 2: GET all resources
image
Example 3: POST resource
image
Python Examples
Example 1: GET single resource
image
Example 2: GET all resources
image
Example 3: POST resource
image


## Description

A tutorial review of the tutorial has been done. Modified part of the text description of the

Choose a reason for hiding this comment

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

Was there a modification to the tutorial? Could you clarify this part

Copy link

@ctrlvish ctrlvish left a comment

Choose a reason for hiding this comment

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

Hey @RUNQILIU-123 and Suylang, great review of the existing tutorial. I've reviewed all the screenshots and they seem good.

I had a quick questions because the review had a line saying there was a text description that was modified, could you clarify if this is the description of the tutorial itself? And if so could you include the change in this PR?

Copy link

@ctrlvish ctrlvish left a comment

Choose a reason for hiding this comment

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

I approve this PR

Copy link

@seventhback777 seventhback777 left a comment

Choose a reason for hiding this comment

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

The greatest advantage of this node is that the tutorial structure is clear, covering multiple language implementations and being runnable. It is recommended to supplement error handling and automated verification (CI badge and log screenshots), cross-platform operation guidelines, as well as PR links and version lock information. This can significantly enhance reproducibility and engineering credibility, and is also more in line with the standards of "high quality and maintainability". I think this pr is very good!

- [Pull Request]()

## Improvements and suggestions

Choose a reason for hiding this comment

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

It is recommended to supplement error handling examples for non-200 response and timeout scenarios, and attach running screenshots to enhance reproducibility.

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.

3 participants