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

fixing make-docs issue with some update in code #1391

Merged

Conversation

omkarkhatavkar
Copy link

This pull request addresses an issue encountered when generating documentation using Sphinx in the Airgun project. The problem arose due to incompatible type annotations causing errors during the documentation build process.

To resolve this issue, the following changes were made:

  • Updated the docstring of the affected module to provide clearer and more descriptive documentation.
  • Removed type annotations from the codebase to ensure compatibility

These changes ensure that the documentation build process (make -docs) in Airgun proceeds smoothly without encountering errors related to type annotations.

Copy link
Contributor

@vsedmik vsedmik left a comment

Choose a reason for hiding this comment

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

Please append appropriate labels

@omkarkhatavkar omkarkhatavkar added CherryPick PR needs CherryPick to previous branches 6.12.z 6.13.z 6.14.z 6.15.z labels May 22, 2024
@omkarkhatavkar
Copy link
Author

merging this on priority as other pr's are getting stuck because of this.

@omkarkhatavkar omkarkhatavkar merged commit cecb4da into SatelliteQE:master May 22, 2024
9 of 10 checks passed
github-actions bot pushed a commit that referenced this pull request May 22, 2024
github-actions bot pushed a commit that referenced this pull request May 22, 2024
github-actions bot pushed a commit that referenced this pull request May 22, 2024
github-actions bot pushed a commit that referenced this pull request May 22, 2024
Gauravtalreja1 pushed a commit that referenced this pull request May 22, 2024
(cherry picked from commit cecb4da)

Co-authored-by: Omkar Khatavkar <[email protected]>
Gauravtalreja1 pushed a commit that referenced this pull request May 22, 2024
(cherry picked from commit cecb4da)

Co-authored-by: Omkar Khatavkar <[email protected]>
Gauravtalreja1 pushed a commit that referenced this pull request May 22, 2024
(cherry picked from commit cecb4da)

Co-authored-by: Omkar Khatavkar <[email protected]>
Gauravtalreja1 pushed a commit that referenced this pull request May 22, 2024
(cherry picked from commit cecb4da)

Co-authored-by: Omkar Khatavkar <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
6.12.z 6.13.z 6.14.z 6.15.z CherryPick PR needs CherryPick to previous branches
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants