Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

fix(doc-gen): correctly transform index files #3021

Closed
wants to merge 4 commits into from

Conversation

petebacondarwin
Copy link
Contributor

@matsko I think this is a fix but have not written tests

@xdissent
Copy link
Contributor

This bug was introduced in 86f3e41. Before that commit, all additional arguments were passed to the transform function, not just the first as seen in this PR. This will also fix #2370 I believe.

@petebacondarwin
Copy link
Contributor Author

@xdissent - Nice spot. Sorry that was my commit! I will revert that aspect.

@xdissent
Copy link
Contributor

I wasn't going to point any fingers! ;-)

@petebacondarwin
Copy link
Contributor Author

OK, so you can now run the "few" doc-gen related specs with

grunt test:docgen

I have added a test that demonstrates the issue and a fix.

@petebacondarwin
Copy link
Contributor Author

It uses new npm modules so you'll need to npm install first.

@matsko
Copy link
Contributor

matsko commented Jun 24, 2013

Perhaps we could also include a docs:generate command that would be called without running the tests (like jasmine-node does). This would be helpful when running on autotest:docs in the background while testing docs pages (since they have to be generated each time to test them).

@matsko
Copy link
Contributor

matsko commented Jun 24, 2013

Ohh nice you got a test written :) @petebacondarwin

@petebacondarwin
Copy link
Contributor Author

@matsko grunt docs generates the docs without running the tests. This is why I created the new grunt task.

@matsko
Copy link
Contributor

matsko commented Jun 24, 2013

Cool. I've been using node docs/src/gen-docs.js to do that. Thanks for the heads up :)

@matsko
Copy link
Contributor

matsko commented Jun 24, 2013

@petebacondarwin the to file is still being generated. I tried it on the latest commit.

@petebacondarwin
Copy link
Contributor Author

@matsko - can you try now? I have rebased on master.

@matsko
Copy link
Contributor

matsko commented Jun 25, 2013

Works! :)

@petebacondarwin
Copy link
Contributor Author

Great! I think I'll merge this tonight.

@petebacondarwin petebacondarwin deleted the docs-fix branch June 25, 2013 20:20
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants