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

Fix various doc links in SDKs #8331

Merged
merged 13 commits into from
Dec 9, 2024
Merged

Fix various doc links in SDKs #8331

merged 13 commits into from
Dec 9, 2024

Conversation

Wumpf
Copy link
Member

@Wumpf Wumpf commented Dec 5, 2024

PR title is an accompanying changelog entry, but the real thing here is all about codegen fixes:

  • use reporter for doc issues
  • make reporter output colored
  • support field & enum links - this is a bit limited depending on the language. Experimented a bit, but deemed this now good enough. We don't use those often anyways
  • fix links
  • disable warnings for python autogen serialization being available when a custom one is present - in all cases we have the custom serialization there for a good reason or aren't entirely sure if it would break something

@Wumpf Wumpf added 📖 documentation Improvements or additions to documentation 🧑‍💻 dev experience developer experience (excluding CI) codegen/idl include in changelog labels Dec 5, 2024
Copy link

github-actions bot commented Dec 5, 2024

Latest documentation preview deployed successfully.

Result Commit Link
139c7db https://landing-c217e3gxf-rerun.vercel.app/docs

Note: This comment is updated whenever you push a commit.

Copy link

github-actions bot commented Dec 5, 2024

Web viewer built successfully. If applicable, you should also test it:

  • I have tested the web viewer
Result Commit Link
139c7db https://rerun.io/viewer/pr/8331

Note: This comment is updated whenever you push a commit.

@Wumpf Wumpf marked this pull request as draft December 5, 2024 17:11
@Wumpf
Copy link
Member Author

Wumpf commented Dec 5, 2024

drafted: some links are wrong, need to fix this up

@Wumpf Wumpf force-pushed the andreas/fix-codegne-warnings branch 2 times, most recently from 02b8ff5 to 3b5a3d7 Compare December 6, 2024 10:44
@Wumpf Wumpf marked this pull request as ready for review December 6, 2024 12:11
@emilk emilk self-requested a review December 9, 2024 07:59
Copy link
Member

@emilk emilk left a comment

Choose a reason for hiding this comment

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

Awesome, thank you!

Can we fix the contents of docstring_md while we're at it? 🙏

@Wumpf Wumpf force-pushed the andreas/fix-codegne-warnings branch from 5a7ef0c to d94d907 Compare December 9, 2024 11:26
@Wumpf Wumpf merged commit 1aa3427 into main Dec 9, 2024
36 of 37 checks passed
@Wumpf Wumpf deleted the andreas/fix-codegne-warnings branch December 9, 2024 15:27
teh-cmc pushed a commit that referenced this pull request Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
codegen/idl 🧑‍💻 dev experience developer experience (excluding CI) 📖 documentation Improvements or additions to documentation include in changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants