Skip to content

Comments

update of help strings#174

Merged
tocker merged 6 commits intomasterfrom
docs/js-strings
May 22, 2019
Merged

update of help strings#174
tocker merged 6 commits intomasterfrom
docs/js-strings

Conversation

@MeirFeinberg
Copy link
Contributor

No description provided.

@MeirFeinberg MeirFeinberg requested a review from tocker April 29, 2019 14:33
@tocker tocker force-pushed the docs/js-strings branch from 544a943 to f494724 Compare May 5, 2019 12:52
var ClientHintsMetaTag = class ClientHintsMetaTag extends HtmlTag {
/**
* Creates an HTML (DOM) Meta tag that enables client-hints.
* Creates an HTML (DOM) Meta tag that enables Client-Hints for the HTML page. <br/>
Copy link
Contributor

Choose a reason for hiding this comment

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

Missing parameter options in the doc comment

* @see <a href="https://cloudinary.com/documentation/image_transformation_reference"
* target="_blank">Available image transformations</a>
* @see <a href="https://cloudinary.com/documentation/video_transformation_reference"
* target="_blank">Available video transformations</a>
Copy link
Contributor

Choose a reason for hiding this comment

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

Missing parameter options in the doc comment.

* var cl = new cloudinary.Cloudinary( { cloud_name: "mycloud"});
* var imgTag = cl.image("myPicID");
*/
* Main class for accessing Cloudinary functionality.
Copy link
Contributor

Choose a reason for hiding this comment

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

Update this :-)


/**
* Defaults configuration.
* Default configuration.
Copy link
Contributor

Choose a reason for hiding this comment

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

original meaning was "a configuration object that serves default values", hence the plural tense. If we change it, it should be to something like "A configuration for the various SDK functions"...

Copy link
Contributor

@jackieros jackieros left a comment

Choose a reason for hiding this comment

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

In an attempt to just fix the couple of helpstring changes you made in your commits, I came across a bunch of helpstrings throughout that are missing periods.
Started fixing here, but makes more sense to do a global review locally and commit. Will ask @MeirFeinberg to fix alongside the other items he's supposed to handle.

Co-Authored-By: jackieros <jackie@cloudinary.com>
@tocker tocker merged commit 7d34d3a into master May 22, 2019
@tocker tocker deleted the docs/js-strings branch June 6, 2019 07:11
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.

3 participants