Add inline doc comments to the Web SDK template #721
Conversation
|
I have added the comments by referencing the PR for doc comments for Dart & Flutter as mentioned in the original issue here. Also, there were some comments missing for the client.ts.twig file (for RealtimeResponse, RealtimeRequest, RealtimeResponseEvent etc), I have added these from my end. Please lmk in case I have missed anything, I'll add it asap. |
|
Hi @Im-Madhur-Gupta great work, we would like to proceed with this, if you are still interested to complete this, can you please sync this with latest changes. No worries if you are no longer working on this just let us know. Thank you. |
|
Sure @lohanidamodar, let me sync my branch with master. Will do this in a bit. |
|
@lohanidamodar I have merged my branch with master, pls check. Thanks. |
|
Hey there! There were a lot of big PRs during this Hacktoberfest, and we wanted to give everyone ample time to collaborate with our engineering team. If you were able to merge your PRs during October, amazing. If it’s still not merged, don’t worry about it either. Either way, we’ve got your Hacktoberfest swag minted and ready to ship. Please comment with your Discord username here so we can contact you about your shipping information to deliver your Hacktoberfest swag. |
|
Hi @gewenyu99, thank you, here is my Discord username: immadhurgupta |
templates/web/README.md.twig
Outdated
| @@ -1,7 +1,7 @@ | |||
| # {{ spec.title }} {{sdk.name}} SDK | |||
|
|
|||
|  | |||
|  | |||
|  | slice(0,2) | join('.') ~ '.x' | url_encode }}-blue.svg?style=flat-square) | |||
There was a problem hiding this comment.
@Im-Madhur-Gupta Where did this change come from?
There was a problem hiding this comment.
Hi, facing some medical issues currently, will get back to you in a couple of days.
There was a problem hiding this comment.
@lohanidamodar Apologies for the delay in reply, I added this code while I was working on the ticket to fix some issue with the version batch but as I can see now we don't need it, hence I have reverted this change and pushed it.
What does this PR do?
This PR adds inline comments to the web SDK template. These comments will be visible in IDEs.
Test Plan
I generated the SDK from the web template after making changes into it using
example.php. This verified that the comments were showing up correctly.Related PRs and Issues
Have you read the Contributing Guidelines on issues?
Yes, I have.