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: mark accessors that were autogenerated but documented as removed in 10 #12677

Merged
merged 2 commits into from Apr 5, 2021

Conversation

ewanharris
Copy link
Collaborator

This PR is related to #12661 and #12654 and removes some accessor functions that were documented properly (i.e existed in the yml docs and were not autogenerated by the docs scripts) but were actually backed by the auto-generation of accessors. Namely:

  • Ti.Android.Intent.getData
  • Ti.Android.MenuItem.setCheckable
  • Ti.Android.MenuItem.setChecked
  • Ti.Android.MenuItem.setEnabled
  • Ti.Android.MenuItem.setVisible
  • Ti.Android.MenuItem.isActionViewExpanded
  • Ti.Android.MenuItem.isCheckable
  • Ti.Android.MenuItem.isChecked
  • Ti.Android.MenuItem.isEnabled
  • Ti.Android.MenuItem.isVisible
  • Ti.Network.HTTPClient.setTimeout (this is fine to remove as it is not part of the spec)
  • Ti.UI.TableView.setHeaderPullView (iOS only)

It does not (yet) deal with the following APIs:

  • Ti.UI.Tab.setWindow - This exists on Android but not iOS
  • Sound.isLooping - This exists on iOS but not Android
  • Sound.isPlaying - This exists on iOS but not Android
  • Sound.isPaused - This exists on iOS but not Android

Personally, I think we should just remove the above APIs rather than have a difference between iOS and Android. But, that's like just my opinion so I'm open to suggestions

JIRA

@ewanharris ewanharris requested review from sgtcoolguy and a team March 30, 2021 17:29
@build build added this to the 10.1.0 milestone Mar 30, 2021
@build build requested a review from a team March 30, 2021 17:31
@build build added the docs label Mar 30, 2021
@build
Copy link
Contributor

build commented Mar 30, 2021

Fails
🚫 Tests have failed, see below for more information.
🚫

Test suite crashed on iOS simulator. Please see the crash log for more details.

Messages
📖 ✊ The commits in this PR match our conventions! Feel free to Rebase and Merge this PR when ready.
📖 ❌ 5 tests have failed There are 5 tests failing and 230 skipped out of 4686 total tests.

Tests:

ClassnameNameTimeError
android.emulator.fs#renameSync() renames a file (5.0.2)9.849
Error: Timeout of 2000ms exceeded. For async tests and hooks, ensure "done()" is called; if returning a Promise, ensure it resolves. (app.js)
android.emulator.Titanium.UI.NavigationWindowbasic open/close navigation (5.0.2)10.017
Error: Timeout of 10000ms exceeded. For async tests and hooks, ensure "done()" is called; if returning a Promise, ensure it resolves. (app.js)
android.emulator.Titanium.UI.Window"after each" hook for "window_close_order_1" (5.0.2)7.262
Error: Timeout of 5000ms exceeded. For async tests and hooks, ensure "done()" is called; if returning a Promise, ensure it resolves. (app.js)
android.emulator.Titanium.UI.View"after all" hook for "rgba fallback" (5.0.2)23.549
Error: Timeout of 10000ms exceeded. For async tests and hooks, ensure "done()" is called; if returning a Promise, ensure it resolves. (app.js)
android.emulator.Titanium.UI.View"after each" hook for "getOrCreateView() should always return a View" (5.0.2)13.533
Error: Timeout of 10000ms exceeded. For async tests and hooks, ensure "done()" is called; if returning a Promise, ensure it resolves. (app.js)

Generated by 🚫 dangerJS against 663bef8

apidoc/Titanium/Android/MenuItem.yml Outdated Show resolved Hide resolved
@vijaysingh-axway
Copy link
Contributor

I think, we can deprecate following APIs in favor of corresponding properties. Probably we can create a ticket to track it.
Sound.isLooping - This exists on iOS but not Android
Sound.isPlaying - This exists on iOS but not Android
Sound.isPaused - This exists on iOS but not Android

@sgtcoolguy sgtcoolguy merged commit 92603cd into tidev:master Apr 5, 2021
@sgtcoolguy sgtcoolguy added the backport 10_2_X when applied, PRs with this label will get an auto-generated backport to 10_2_X branch on merge label Apr 5, 2021
@build build removed the backport 10_2_X when applied, PRs with this label will get an auto-generated backport to 10_2_X branch on merge label Apr 5, 2021
@ewanharris ewanharris deleted the TIMOB-28407 branch April 6, 2021 08:49
@sgtcoolguy
Copy link
Contributor

@ewanharris We chatted on teams about this, but to summarize my thoughts:

Personally I think the get/set methods can be marked deprecated/removed in 10.0.0 since they fell under what we were attempting to get rid of around autogenerated accessors. I think the is* boolean query methods are less obvious and we should deprecate them in 10.0.0, but not remove them.

So we should:

  • add back the @Kroll.method annotations for the MenuItem ones and not mark them removed yet in docs
  • mark the Sound.is* methods deprecated in docs.
  • remove Ti.UI.Tab.setWindow and note it as such in the docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants