Skip to content

Config: Add in docs property for 1.11.3 #264

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

Closed
wants to merge 3 commits into from
Closed

Config: Add in docs property for 1.11.3 #264

wants to merge 3 commits into from

Conversation

xbili
Copy link
Contributor

@xbili xbili commented Mar 7, 2015

This was preventing grunt prepare from running.

After looking through the code again from this, the if-else loop appears to be correct. My mistake on that. But the config.json file seems to require a doc property in order for the if-else loop to be executed correctly.

If not npm install wouldn't run for tmp/api.jquery.com. Do let me know if there are any mistakes with this!

Fixes issue 262 and also this.

Thanks!

This was preventing `grunt prepare` from running npm install in
api.jquery.com.
@rxaviers
Copy link
Member

rxaviers commented Mar 7, 2015

Hi @xbili, thanks for your contribution.

Actually, 1.11 package (and on) doesn't embed documentation anymore. So, we shouldn't add "docs": true into the config. But, the prepare task is indeed broken (#262). In order to fix this, we actually should skip "Building API documentation for jQuery UI" if jqueryUi.docs is undefined.

@xbili
Copy link
Contributor Author

xbili commented Mar 8, 2015

I see, thanks for pointing that out. I've wrapped the process into an if-else loop in the prepare function instead. Do let me know if there are any issues with this. Thanks!

cwd: "tmp/api.jqueryui.com"
}
}, log( callback, "Done building documentation", "Error building documentation" ) );
}
Copy link
Member

Choose a reason for hiding this comment

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

Please, I prefer you add a silent return callback and avoid the else condition (let else be the normal flow).

if ( !jqueryUi.docs ) {
   return callback();
}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@rxaviers Sorry about that, I've made the changes.

@rxaviers rxaviers closed this in 049755d Mar 8, 2015
@rxaviers
Copy link
Member

rxaviers commented Mar 8, 2015

Thank you. Please, just let me know if you need this published for your jqueryui.com work.

@xbili
Copy link
Contributor Author

xbili commented Mar 8, 2015

@rxaviers You're welcome, I think manually running npm install for now will do. Thanks!

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

Successfully merging this pull request may close these issues.

3 participants