Skip to content

Fix translation template init documentation - #2004

Open
HazizCISSE wants to merge 1 commit into
robotframework:masterfrom
HazizCISSE:fix/translation-init-intro-docs
Open

HazizCISSE wants to merge 1 commit into
robotframework:masterfrom
HazizCISSE:fix/translation-init-intro-docs

Conversation

@HazizCISSE

Copy link
Copy Markdown

Summary

selib translation used the library instance documentation for __init__, causing the generated JSON to repeat the introduction instead of documenting the import arguments.

Read the constructor documentation with inspect.getdoc(type(selib).__init__) and calculate its SHA-256 checksum from that text. This follows the fix in MarketSquare/robotframework-browser#5222.

Add regression tests verifying that __init__ contains the constructor documentation, differs from __intro__, and has the correct checksum.

Validation

  • Ruff formatting and lint checks passed.
  • Unit tests passed across all three Python/Robot Framework/Selenium combinations in the push/PR CI matrix.
  • Translation JSON generation and comparison passed in all four configurations.
  • Full acceptance suites ran locally on macOS with Chrome and Firefox. Reproducible failures also occurred on the unchanged upstream commit; intermittent alert failures passed on targeted reruns.

The Ubuntu/Xvfb environment used by GitHub Actions was not reproduced locally.

This branch has not been deployed

No deployments
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.

1 participant