Skip to content

Commit 73ce15e

Browse files
committed
pidl: Update documentation for DCERPC interface connections
https://realpython.com/documenting-python-code/ BUG: https://bugzilla.samba.org/show_bug.cgi?id=15680 Signed-off-by: Andreas Schneider <[email protected]> Reviewed-by: Stefan Metzmacher <[email protected]>
1 parent 2c171fb commit 73ce15e

File tree

1 file changed

+24
-5
lines changed

1 file changed

+24
-5
lines changed

pidl/lib/Parse/Pidl/Samba4/Python.pm

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1597,11 +1597,30 @@ sub Interface($$$)
15971597
$self->pidl("");
15981598

15991599
my $signature =
1600-
"\"$interface->{NAME}(binding, lp_ctx=None, credentials=None) -> connection\\n\"
1601-
\"\\n\"
1602-
\"binding should be a DCE/RPC binding string (for example: ncacn_ip_tcp:127.0.0.1)\\n\"
1603-
\"lp_ctx should be a path to a smb.conf file or a param.LoadParm object\\n\"
1604-
\"credentials should be a credentials.Credentials object.\\n\\n\"";
1600+
"\"$interface->{NAME}(binding, lp_ctx=None, credentials=None, basis_connection=None) -> connection\\n\"
1601+
\"\\n\\n\"
1602+
\"Parameters\\n\"
1603+
\"----------\\n\"
1604+
\"binding : str\\n\"
1605+
\" A DCE/RPC binding string (for example: ncacn_ip_tcp:127.0.0.1)\\n\"
1606+
\"lp_ctx : param.LoadParm\\n\"
1607+
\" Should be a path to a smb.conf file or a param.LoadParm object\\n\"
1608+
\"credentials : credentials.Credentials, optional\\n\"
1609+
\" A credentials.Credentials object (default is None).\\n\"
1610+
\"basis_connection : samba.dcerpc.ClientConnection, optional\\n\"
1611+
\" A $interface->{NAME} client connection object (default is None).\\n\"
1612+
\"\\n\\n\"
1613+
\"Returns\\n\"
1614+
\"-------\\n\"
1615+
\"samba.dcerpc.ClientConnection\\n\"
1616+
\" A ClientConnection object\\n\"
1617+
\"\\n\\n\"
1618+
\"Raises\\n\"
1619+
\"------\\n\"
1620+
\"samba.NTSTATUSError\\n\"
1621+
\" An NTSTATUS error\\n\"
1622+
\"\\n\"";
1623+
16051624

16061625
my $docstring = $self->DocString($interface, $interface->{NAME});
16071626

0 commit comments

Comments
 (0)