tschaub/gh-pages

options.history in the documentation is confusing to understand

Opened this issue · 0 comments

rodet commented

This is how it looks like at the moment:

image

Reading this, I can't be sure if the history is kept or not when this is set to true. I'm also not sure what the example does: keep or erase the history? A very short clarification would be super useful, ie "setting this option to true (or false?) will cause a force push that will discard the previous history. You might use it to save space in your repository in case the branch content is the output from a build process".

As a good example, I find the command line help clearer:

-f, --no-history Push force new commit without parent history