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

Readme inconsistency - groupTitle or title? #119

Closed
soyuka opened this issue Sep 24, 2014 · 1 comment
Closed

Readme inconsistency - groupTitle or title? #119

soyuka opened this issue Sep 24, 2014 · 1 comment
Labels

Comments

@soyuka
Copy link
Contributor

soyuka commented Sep 24, 2014

https://github.com/Vertafore/docular#groups :

groups: [
        {
            id: "api",
            title:"API's",
            files: grunt.file.expand(['downloaded/angular/angular.js-' + version + '/src/**/*.js'])
        },
]

or

https://github.com/Vertafore/docular#a-complete-example

groups: [
                    {
                        groupId: "api",
                        groupTitle:"API's",
                        files: grunt.file.expand(['src/**/*.js', '!src/**/*.spec.js', '!src/**/lib/**/*.js'])
                    }
                ]

Which one is the right one?

Also, you should link the grunt-docular readme to the one here, assuming it's not up to date?

@stephenliberty
Copy link
Contributor

For your question - technically both are right. The "id" key will get renamed to "groupId", and "title" will get renamed to "groupTitle". I'll add this in to the list of things that need getting fixed.

stephenliberty pushed a commit that referenced this issue Sep 25, 2014
Fix #119 - Readme consistency
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants