Fix documentation for nested enums (#351)

This commit is contained in:
Gabriel Pajot
2022-03-18 23:36:27 +01:00
committed by GitHub
parent 1aaf7728cc
commit 5f7e4d58ef
3 changed files with 54 additions and 23 deletions

View File

@@ -2,27 +2,39 @@ syntax = "proto3";
package nestedtwice;
/* Test doc. */
message Test {
/* Top doc. */
message Top {
/* Middle doc. */
message Middle {
/* TopMiddleBottom doc.*/
message TopMiddleBottom {
// TopMiddleBottom.a doc.
string a = 1;
}
/* EnumBottom doc. */
enum EnumBottom{
/* EnumBottom.A doc. */
A = 0;
B = 1;
}
/* Bottom doc. */
message Bottom {
/* Bottom.foo doc. */
string foo = 1;
}
reserved 1;
/* Middle.bottom doc. */
repeated Bottom bottom = 2;
repeated EnumBottom enumBottom=3;
repeated TopMiddleBottom topMiddleBottom=4;
bool bar = 5;
}
/* Top.name doc. */
string name = 1;
Middle middle = 2;
}
/* Test.top doc. */
Top top = 1;
}

View File

@@ -0,0 +1,25 @@
import pytest
from tests.output_betterproto.nestedtwice import (
Test,
TestTop,
TestTopMiddle,
TestTopMiddleBottom,
TestTopMiddleEnumBottom,
TestTopMiddleTopMiddleBottom,
)
@pytest.mark.parametrize(
("cls", "expected_comment"),
[
(Test, "Test doc."),
(TestTopMiddleEnumBottom, "EnumBottom doc."),
(TestTop, "Top doc."),
(TestTopMiddle, "Middle doc."),
(TestTopMiddleTopMiddleBottom, "TopMiddleBottom doc."),
(TestTopMiddleBottom, "Bottom doc."),
],
)
def test_comment(cls, expected_comment):
assert cls.__doc__ == expected_comment