Skip to content
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.

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

Do not print Unknown Field: when there is an unknown field #288

Closed
tristanlatr opened this issue Nov 24, 2020 · 2 comments
Closed

Do not print Unknown Field: when there is an unknown field #288

tristanlatr opened this issue Nov 24, 2020 · 2 comments

Comments

@tristanlatr
Copy link
Contributor

The expected behaviour, would be, as Sphinx, to just print the field name in bold.
Maybe apply .title().

@mthuurne
Copy link
Contributor

In general I prefer tools to complain loudly when non-existing syntax is used, as that helps discover errors early.

There is the newfield mechanism that can be used to define new fields that pydoctor doesn't know out-of-the-box. It's used in epydoc like this:

:newfield contributor: Contributor, Contributors (Alphabetical Order)
:contributor: `Glyph Lefkowitz  <mailto:[email protected]>`__
:contributor: `Edward Loper  <mailto:[email protected]>`__

@tristanlatr
Copy link
Contributor Author

Replaced by #456

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants