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

Make documentation generation optional and improve objc path specification #320

Merged
merged 1 commit into from
Feb 8, 2024

Conversation

julianlocke
Copy link
Contributor

@julianlocke julianlocke commented Feb 8, 2024

These changes allow generate_base_client.py to be run from directories other than where it is located, the root of SwiftyDropbox.

Paired with: dropbox/SwiftyDropbox#401

  • Documentation generation is now optional
  • -rop flag is removed
  • Comment on --objc option updated updated to not suggest that a single pass generation is possible.
  • _write_output_in_target_folder simplified to just write to self.target_folder_path + file name. For objc generation specify the output location using -o.
  • Reconnection helper code gen made a little bit more flexible by changing the protocol conformance from a handwritten file to the generated one.

Checklist

General Contributing

  • Have you read the Code of Conduct and signed the CLA?

Is This a Code Change?

  • Non-code related change (markdown/git settings etc)
  • Code Change
  • Example/Test Code Change

Validation

  • Have you ran tox?
  • Do the tests pass?

@julianlocke julianlocke requested a review from aaronsky February 8, 2024 16:21
Copy link

codecov bot commented Feb 8, 2024

Codecov Report

Attention: 105 lines in your changes are missing coverage. Please review.

Comparison is base (94fa542) 50.30% compared to head (9871cdf) 49.93%.
Report is 12 commits behind head on swifty-dropbox-beta.

Files Patch % Lines
stone/backends/swift_types.py 0.00% 63 Missing ⚠️
stone/backends/swift_client.py 0.00% 24 Missing ⚠️
stone/cli.py 0.00% 16 Missing ⚠️
stone/backends/swift.py 0.00% 1 Missing ⚠️
stone/frontend/ir_generator.py 0.00% 1 Missing ⚠️
Additional details and impacted files
@@                   Coverage Diff                   @@
##           swifty-dropbox-beta     #320      +/-   ##
=======================================================
- Coverage                50.30%   49.93%   -0.38%     
=======================================================
  Files                       37       37              
  Lines                     8740     8805      +65     
  Branches                  1881     1889       +8     
=======================================================
  Hits                      4397     4397              
- Misses                    4026     4091      +65     
  Partials                   317      317              
Flag Coverage Δ
unit 49.93% <0.94%> (-0.38%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@@ -4,7 +4,7 @@

import Foundation

enum {{ class_name }} {
enum {{ class_name }}: ReconnectionHelpersShared {
Copy link

Choose a reason for hiding this comment

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

? – intentional?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's a needed but unrelated change


def _generate_jazzy_docs(self, api):
jazzy_cfg_path = os.path.join('../Format', 'jazzy.json')
Copy link

Choose a reason for hiding this comment

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

nit – sad this relpath still couldn't be fixed

@julianlocke julianlocke merged commit 57c651d into swifty-dropbox-beta Feb 8, 2024
11 of 12 checks passed
@julianlocke julianlocke deleted the improve-stone-gen branch February 8, 2024 17:16
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.

2 participants