Skip to content

Commit

Permalink
Tag TODOs without an issue, see #28
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisklus committed Dec 30, 2019
1 parent 42eba3e commit b86ad68
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion js/generate.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ console.log( 'streaming to ' + OUTPUT_FILE );
// Copy image files
try {

// TODO: this assumes we only need image from two repos
// TODO: this assumes we only need image from two repos, see https://github.com/phetsims/binder/issues/28
fsExtra.copySync( __dirname + '/../../sun/doc/images', __dirname + '/../doc/images/sun' );
fsExtra.copySync( __dirname + '/../../scenery-phet/images', __dirname + '/../doc/images/scenery-phet' );
}
Expand Down
4 changes: 2 additions & 2 deletions js/getFromSimInMaster.js
Original file line number Diff line number Diff line change
Expand Up @@ -136,10 +136,10 @@ module.exports = async commandLineSims => {
sims: dataBySim
};

// TODO: is this the best place for this?
// TODO: is this the best place for this? see https://github.com/phetsims/binder/issues/28
// write data to a file so that we don't have to run this so often for quick iteration.
fs.writeFileSync( __dirname + '/../binderjson.json', JSON.stringify( outputObject, null, 2 ) );

// TODO: is it weird to return an object that is by sim THEN by component. createHTML should probably take a data struture based on component at the top level.
// TODO: is it weird to return an object that is by sim THEN by component. createHTML should probably take a data struture based on component at the top level. see https://github.com/phetsims/binder/issues/28
return outputObject;
};
2 changes: 1 addition & 1 deletion js/getMarkdownFileAsHTML.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ module.exports = function( repo, component ) {
markdown = marked( m.toString() );

// Use subdirectory for images, so that different directories can have images of the same name
// TODO: This may yield false positives, say if code examples have this same term.
// TODO: This may yield false positives, say if code examples have this same term, see https://github.com/phetsims/binder/issues/28
markdown = markdown.split( '<img src="images/' ).join( '<img src="images/' + repo + '/' );
}
catch( e ) {
Expand Down

0 comments on commit b86ad68

Please sign in to comment.