Comment before table causes next entry to be in table

[jpyams]

Steps to Reproduce

In a tomlkit document, add a comment, a table, then a separate entry. Dump the document to TOML.

import tomlkit

doc = tomlkit.document()
doc.add(tomlkit.comment('Comment'))
doc['foo'] = {'name': 'test'}
doc['bar'] = 1
print(tomlkit.dumps(doc))

Expected result

bar is outside the table.

bar = 1
# Comment

[foo]
name = "test"

Actual result

bar is dumped as an entry in foo.

# Comment

[foo]
name = "test"
bar = 1

Additional notes

This behavior only happens with the first key after the table. Subsequent entries are correctly outside the table, though after the comment.

import tomlkit

doc = tomlkit.document()
doc.add(tomlkit.comment('Comment'))
doc['foo'] = {'name': 'test'}
doc['bar'] = 1
doc['baz'] = 1
print(tomlkit.dumps(doc))

gives

# Comment
baz = 1

[foo]
name = "test"
bar = 1

[jpyams]

Funny how rereading the README can make life easier. It looks like when adding a comment tomlkit is expecting me to do

import tomlkit

doc = tomlkit.document()
doc['foo'] = {'name': 'test'}
doc['foo'].comment('Comment')
doc['bar'] = 1
print(tomlkit.dumps(doc))

That gives me

bar = 1
[foo] # Comment
name = "test"

Adding the comment directly to the item also feels a lot more intuitive, so I like this more than what I was doing before.

I'm leaving this issue open because I don't know if what I was doing before is expected to work or not. If what I was doing before was user error, then please go ahead and close this.

[frostming]

I've created a fork of tomlkit v0.7.0 with the issue fixed, try it:

GitHub: https://github.com/frostming/atoml
PyPI: https://pypi.org/project/atoml