cordova-docs
cordova-docs copied to clipboard
apache
Embedding Android WebView doc looks broken
Issue Type [x] Bug [ ] Feature Request
Priority [ ] Minor [x] Major [ ] Critical [ ] Blocker
Environment
- OS: N/A
- Browser: N/A
Description
In https://cordova.apache.org/docs/en/latest/guide/platforms/android/webview.html:
Sample code seems to use a Config object class.
The one place where I see a Config class documented is in: https://developer.android.com/reference/android/util/Config
where I see no init method documented.
As a general rule the document should never assume the user implicitly knows that s/he has to import a class from a package somewhere.
This looks broken to me, hoping to see an explanation and solution someday soon.
P.S. android.util.Config class looks deprecated according to https://developer.android.com/reference/android/util/Config.
ref:
- https://github.com/apache/cordova-android/issues/494
- https://stackoverflow.com/questions/45505956/trying-to-embed-cordova-app-into-native-android
- GH-883 (PR #883)
@martinhorvath commented in https://github.com/apache/cordova-android/issues/494#issuecomment-438313981:
I [...] tried to reflect my findings in this update: apache/cordova-docs@6dc8836
Can somebody check if this is useful for others?
A pull request would be really appreciated.
I had to find out that I really messed up the conventions of the commit and didn't want to create an even bigger mess with a pull request. Should I?
I honestly don't understand how you were able to commit to this repo and where this commit actually "lives". How did you do that @martinhorvath? Which branch did you commit to?
@janpio The commit is in his fork, it's just a GitHub URL/UI thing that makes it appear like it's in apache/cordova-docs.
It indeed is... I thought "lets see what happens if I suggest an edit using the url from the offical docs". So.... what shall I do? :-)
@martinhorvath a pull request would be much easier for us to track and comment on than a loose commit. While we would prefer the proposed commits to be cleaner your proposed commit would be better than nothing.
Got it: https://github.com/martinhorvath/cordova-docs/commit/6dc8836ff669dbd6825093740a3115cb0c08b1c2
You can just create a Pull Request into this repository from your patch-1 branch. Start here @martinhorvath: https://github.com/apache/cordova-docs/compare
And we can always use git show -b 6dc8836 or git diff -b to ignore the space changes.
PR done, I tried my best to follow the contribution guidelines. Would appreciate if you let me know what I missed to do. --> https://github.com/apache/cordova-docs/pull/904