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.

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

[SPARK-46775][DOCS] Fix formatting of Kinesis docs #44802

Closed
wants to merge 1 commit into from

Conversation

nchammas
Copy link
Contributor

@nchammas nchammas commented Jan 19, 2024

What changes were proposed in this pull request?

  • Convert the mixed indentation styles (tabs and spaces) to spaces only.
  • Add syntax highlighting to the code blocks.
  • Fix a couple of broken links to API docs.

Why are the changes needed?

This makes the docs a bit easier to read and edit.

Does this PR introduce any user-facing change?

Yes, it changes the formatting of this documentation.

How was this patch tested?

I built the docs and manually reviewed them.

Was this patch authored or co-authored using generative AI tooling?

No.

@github-actions github-actions bot added the DOCS label Jan 19, 2024
.build();
```

See the [API docs](api/java/org/apache/spark/streaming/kinesis/package-summary.html)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The old link was broken, but I cannot find a Java API doc for KinesisInputDStream so I just linked to the package summary.

Maybe @HeartSaVioR knows what's going on here?

.build()
```

See the [API docs](api/scala/org/apache/spark/streaming/kinesis/KinesisInputDStream$.html)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The old link was also broken here. It just needed the $ at the end.

@nchammas nchammas changed the title [SPARK-46775][SS] Fix formatting of Kinesis docs [SPARK-46775][DOCS] Fix formatting of Kinesis docs Jan 19, 2024
@HyukjinKwon
Copy link
Member

Merged to master.

@nchammas nchammas deleted the kinesis-docs branch January 22, 2024 01:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
2 participants