Skip to content

Update Java Client API reference#1069

Merged
ods merged 1 commit intoaio-libs:masterfrom
emmanuel-ferdman:master
Nov 1, 2024
Merged

Update Java Client API reference#1069
ods merged 1 commit intoaio-libs:masterfrom
emmanuel-ferdman:master

Conversation

@emmanuel-ferdman
Copy link
Copy Markdown
Contributor

Changes

Small PR - fixes the Java Client API reference

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • Add a new news fragment into the CHANGES folder
    • name it <issue_id>.<type> (e.g. 588.bugfix)
    • if you don't have an issue_id change it to the pr id after creating the PR
    • ensure type is one of the following:
      • .feature: Signifying a new feature.
      • .bugfix: Signifying a bug fix.
      • .doc: Signifying a documentation improvement.
      • .removal: Signifying a deprecation or removal of public API.
      • .misc: A ticket has been closed, but it is not of interest to users.
    • Make sure to use full sentences with correct case and punctuation, for example: Fix issue with non-ascii contents in doctest text files.

Signed-off-by: Emmanuel Ferdman <[email protected]>
@ods
Copy link
Copy Markdown
Collaborator

ods commented Oct 31, 2024

Hi @emmanuel-ferdman,
What problem do you see in the current version? This reference in the generated doc works fine for me.

@emmanuel-ferdman
Copy link
Copy Markdown
Contributor Author

@ods, it leads to error page at https://aiokafka.readthedocs.io/en/stable/JavaClientAPI:
image

On that page, there are two links that should lead to https://kafka.apache.org/documentation/#api. The first one works, while the second one (which unlike the first one, uses a custom clickable text with a cross-reference label) does not work.

@ods
Copy link
Copy Markdown
Collaborator

ods commented Nov 1, 2024

Oh, I see. Thank you for the fix!

@ods ods merged commit 2bd8d25 into aio-libs:master Nov 1, 2024
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.

2 participants