New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Convert comments into docstrings #14

Open

mithro opened this issue Jul 8, 2019 · 1 comment

Member

mithro commented Jul 8, 2019

You have a lot of comments like this;
https://github.com/duck2/uxsdcxx/blob/65c17a2b626e4d2429256db89b5496e2788ffa99/uxsdcxx.py#L456-L458

They should instead be written like this;

# May cause a bug: sets aren't guaranteed to be ordered.
def _gen_state_tables(t: XsdComplexType) -> str:
    """Generate state transition tables, indexed by token enums."""

Generally all functions should have these docstrings.

Member

duck2 commented Aug 7, 2019

I have added some docstrings:
https://github.com/duck2/uxsdcxx/blob/25d8b1c799c87e48e0e268d73ee418b62a7e2bce/uxsdcxx.py#L474-L488

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment