Add space to separate comments from tokens #216

polyzen · 2019-09-14T22:01:16Z

polyzen commented

2019-09-14 22:01:16 +00:00

https://yaml.org/spec/1.2/spec.html#id2780069

Seems like this is all that needs to be done, but not sure.

https://yaml.org/spec/1.2/spec.html#id2780069 Seems like this is all that needs to be done, but not sure.

witten commented

2019-09-14 23:21:11 +00:00

Thanks for catching this! Would you mind updating the tests as well to reflect this change? The tests in question are in tests/integration/config/test_generate.py.

Thanks for catching this! Would you mind updating the tests as well to reflect this change? The tests in question are in `tests/integration/config/test_generate.py`.

polyzen commented

2019-09-16 20:43:27 +00:00

Is there special handling that needs to be done to make sure commented blank lines don't turn into # ?

Edit: There's a space after # that isn't being rendered.

Is there special handling that needs to be done to make sure commented blank lines don't turn into `# `? Edit: There's a space after # that isn't being rendered.

witten commented

2019-09-16 22:32:14 +00:00

Not sure. I don't see any cases in the generated config file (with your code changes in place) where blank lines get commented out. Is there somewhere you're seeing a blank line get commented?

polyzen reviewed 2019-09-18 00:04:09 +00:00

tests/integration/config/test_generate.py

polyzen commented

2019-09-18 00:04:09 +00:00

Is there somewhere you’re seeing a blank line get commented?

Here and below I had to do as such.

> Is there somewhere you’re seeing a blank line get commented? Here and below I had to do as such.

witten reviewed 2019-09-18 16:29:31 +00:00

tests/integration/config/test_generate.py

witten commented

2019-09-18 16:29:31 +00:00

Ah, gotcha! Okay, if you want to prevent commented-out blank lines from ending up with a space after the #, you can change the commenting-out logic a bit. I'll add a note where you can do that above.

Ah, gotcha! Okay, if you want to prevent commented-out blank lines from ending up with a space after the `#`, you can change the commenting-out logic a bit. I'll add a note where you can do that above.

witten reviewed 2019-09-18 16:31:24 +00:00

borgmatic/config/generate.py

witten commented

2019-09-18 16:31:24 +00:00

So, if you want to deal with the blank line situation, you could do something like this:

    if not line:
        return '#'
    elif not line.startswith(one_indent):
        return '# ' + line

So, if you want to deal with the blank line situation, you could do something like this: ```python if not line: return '#' elif not line.startswith(one_indent): return '# ' + line ```

polyzen reviewed 2019-09-18 17:24:30 +00:00

borgmatic/config/generate.py

polyzen commented

2019-09-18 17:24:30 +00:00

As there are no commented blank lines in the generated config, I thought the flexmock line in the tests had to be changed. Perhaps both?

witten reviewed 2019-09-18 17:58:14 +00:00

borgmatic/config/generate.py

witten commented

2019-09-18 17:58:14 +00:00

It's really up to you. I could see either changing the tests as you already did, or changing the code to handle the blank line special case. Just let me know!