question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Documentation issues with 1.42 release

See original GitHub issue

I’m updating my Typescript typings (ref #5717 ) based on the docs and found a few minor issues.

  • A few things on the new Resource class:
    • I suspect you probably didn’t mean to make the instance method retryOnError public; that, or I’m not creative enough to think of when an API user would call it
    • The static post claims to be able to take a “string or object” as its sole parameter but fails if options.data is not defined. This was likely copy/pasted from the fetch static method, because it still says “calls fetch() on it” (not “calls post() on it”)
    • This might be intentional but several methods transparently use a method parameter on the options object, even though this param is not defined on the public API. I for one would like to be able to make an OPTIONS or HEAD call against a Resource, if I’m going to use the class anyway.
  • KmlDataSource static load doesn’t list the ability to use a Resource as data but under the hood it’s just making an anonymous instance and calling its load method (which can) – it should have the exact same docs as the instance method. While you’re at it, the instance method still lists a query param with no note about deprecation.
  • I’m unclear if GoogleEarthEnterpriseMapsProvider can take a Resource as a constructor option (url) because I see Resource.createIfNeeded(url + path) – I assume that “(Resource instance) plus (string)” is not what was intended here. Similarly, the get for .url just returns this._url instead of this._resource.url.
  • I can’t find if any ImageryProvider implementations actually inherit from ImageryProvider. ImageryProvider has various default{channel} attributes that never appear to be used anywhere else?
  • The new Plane.projectPointOntoPlane method is missing a return type annotation (it’s Cartesian3)
  • The showOnScreen option to the Credit constructor is incorrectly listed as a String

Hope you don’t mind me dumping everything in one place, but I wasn’t sure how best to divide up into separate issues.

Issue Analytics

  • State:closed
  • Created 6 years ago
  • Comments:12 (12 by maintainers)

github_iconTop GitHub Comments

1reaction
tfilicommented, Feb 13, 2018

See PR #6211 for the hopefully final changes to fix the Resource class.

The two doc issues should have already been fixed yesterday in that branch. I’ve added setQueryParameters and appendQueryParameters. addQueryParameters has been deprecated to avoid confusion.

getDerivedResource now takes a parameter preserveQueryParameters, that will not overwrite the parent’s query parameters, but instead append to them. Defaults to false, so existing functionality is unchanged by default.

Unfortunately Cesium has never paid attention to the order of parameters, so changes would be needed in a bunch of places outside of this class, and I probably won’t be able to get to it right now, since it hasn’t been an issue thus far. A URLSearchParams polyfill is a good suggestion that I’ll keep in mind. Thanks for your suggestions.

0reactions
mramatocommented, Jun 3, 2020

As far as I can tell, everything referenced in the original issue description has been fixed. If there are any small things we missed, please open a new issue for them. Thanks!

Read more comments on GitHub >

github_iconTop Results From Across the Web

Documentation issues with 1.42 release #6205 - GitHub
I'm updating my Typescript typings (ref #5717 ) based on the docs and found a few minor issues. A few things on the...
Read more >
Troubleshooting — conan 1.42.2 documentation
When installing a package which is already installed, but using a different case, will result on the follow error: $ conan install poco/1.10.1@...
Read more >
VMware Tanzu Kubernetes Grid 1.4.2 Release Notes
The following issues from Tanzu Kubernetes Grid v1.4.0 or v1.4.1 have been resolved in v1.4.2. CAPV controller parses datacenter correctly in ...
Read more >
Cisco TelePresence Serial Gateway Series 1.0(1.42)
Describes the features of this release, lists the resolved and open issues, and details the upgrade process.
Read more >
IM PM Version 1.42 - IMBills
IM Practice Manager Version 1.42 Release Documentation. Changes to resolve the following issues were included: All bills with G codes (including those ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found