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

docs: smaller documentation fixes (GitHub links, type parsing etc.) #640

Merged
merged 8 commits into from
Nov 1, 2024

Conversation

barjin
Copy link
Contributor

@barjin barjin commented Oct 31, 2024

Fixes more issues from #324 .

Namely:

  • Fixes broken GitHub links
  • Correctly parses parameter / return types with Python's ast module
  • Handles inheritance better (copies parent's docstring on @override methods)
  • Using @apify/docusaurus-plugin-typedoc-api@4.2.7, expands the Unpack types and further simplifies other helper types (NotRequired, Optional etc.).

@barjin barjin self-assigned this Oct 31, 2024
@github-actions github-actions bot added this to the 101st sprint - Tooling team milestone Oct 31, 2024
@github-actions github-actions bot added the t-tooling Issues with this label are in the ownership of the tooling team. label Oct 31, 2024
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

⚠️ Pull Request Tookit has failed!

Pull request is neither linked to an issue or epic nor labeled as adhoc!

@barjin barjin added the adhoc Ad-hoc unplanned task added during the sprint. label Oct 31, 2024
Copy link
Collaborator

@janbuchar janbuchar left a comment

Choose a reason for hiding this comment

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

LGTM

website/parse_types.py Outdated Show resolved Hide resolved
barjin and others added 2 commits November 1, 2024 10:59
Co-authored-by: Jan Buchar <jan.buchar@apify.com>
@barjin barjin merged commit 49403a1 into master Nov 1, 2024
19 checks passed
@barjin barjin deleted the docs/more-docs-fixes branch November 1, 2024 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants