Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Minor changes #177

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

Merged
merged 6 commits into from
Apr 29, 2025
Merged

Minor changes #177

merged 6 commits into from
Apr 29, 2025

Conversation

adespawn
Copy link
Collaborator

@adespawn adespawn commented Apr 7, 2025

This PR includes few minor changes related to code style and documentation

@adespawn adespawn added this to the Iteration 2 milestone Apr 7, 2025
@adespawn adespawn linked an issue Apr 7, 2025 that may be closed by this pull request
3 tasks
Copy link
Contributor

@ZuzaOsa ZuzaOsa left a comment

Choose a reason for hiding this comment

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

If you change the <code> tags to backticks, exchange also the other HTML tags to their markdown equivalents.

lib/encoder.js Outdated Show resolved Hide resolved
lib/execution-options.js Outdated Show resolved Hide resolved
@adespawn adespawn requested a review from ZuzaOsa April 7, 2025 15:02
lib/policies/retry.js Outdated Show resolved Hide resolved
@ZuzaOsa ZuzaOsa requested a review from Copilot April 8, 2025 12:47
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 39 out of 39 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (1)

lib/client.js:47

  • Consider verifying that the type 'clientOptions.ClientOptions' is consistent with the rest of the project's naming conventions. If the change is intentional, ensure that the corresponding import and usage match the updated type.
 * @param {clientOptions.ClientOptions} options The options for this instance.

Copy link
Contributor

@PiotrJunior PiotrJunior left a comment

Choose a reason for hiding this comment

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

Please explain why you decided to use `` insted of `

@adespawn
Copy link
Collaborator Author

Please explain why you decided to use `` insted of `

Why would I need to explain valid MD syntax?

@wprzytula
Copy link
Contributor

wprzytula commented Apr 16, 2025

Please explain why you decided to use `` insted of `

Why would I need to explain valid MD syntax?

Because it's contrary to the code-wide convention. Every project I've seen, especially ScyllaDB's, uses single backticks.

@adespawn adespawn force-pushed the minor-changes branch 3 times, most recently from f000daa to 1cc09b7 Compare April 18, 2025 16:48
@adespawn adespawn closed this Apr 29, 2025
@adespawn adespawn reopened this Apr 29, 2025
Some of the js-doc types weren't correctly recognized.
This fixes this problem.
@adespawn adespawn merged commit 72d7576 into second-iteration Apr 29, 2025
8 of 9 checks passed
@adespawn adespawn deleted the minor-changes branch April 29, 2025 10:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Consider if html tags should stay in js-docs
4 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.