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: Simplify nested f-string to fix pydoc-markdown parsing #6717

Merged
merged 2 commits into from
Feb 14, 2025

Conversation

malhotra5
Copy link
Contributor

@malhotra5 malhotra5 commented Feb 13, 2025

This PR fixes the build docusaurus GitHub action failure by simplifying a nested f-string that was causing pydoc-markdown to fail parsing on main (https://github.com/All-Hands-AI/OpenHands/actions/runs/13318999934/job/37199704374).

This issue was introduced in #6458

Changes

  • Split the complex nested f-string in gitlab.py into two separate lines
  • Maintains the same functionality while making the code more readable
  • Should resolve the documentation build error

Testing

  • The code change is functionally equivalent
  • Documentation build should now succeed

To run this PR locally, use the following command:

docker run -it --rm   -p 3000:3000   -v /var/run/docker.sock:/var/run/docker.sock   --add-host host.docker.internal:host-gateway   -e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:5b9d790-nikolaik   --name openhands-app-5b9d790   docker.all-hands.dev/all-hands-ai/openhands:5b9d790

@malhotra5 malhotra5 requested a review from enyst February 13, 2025 23:48
@malhotra5 malhotra5 marked this pull request as ready for review February 13, 2025 23:48
Copy link
Collaborator

@enyst enyst left a comment

Choose a reason for hiding this comment

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

Let's try it, thank you!

For some reason I don't see that build in CI (it's optional on a PR, but I thought it will be listed 🤷).

Either way, let's merge, if it's broken.

@malhotra5 malhotra5 merged commit edd5110 into main Feb 14, 2025
14 checks passed
@malhotra5 malhotra5 deleted the fix-pydoc-markdown-parsing branch February 14, 2025 00:29
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.

3 participants