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

inline doesn't need to be documented #917

Open
cjdb opened this issue May 16, 2023 · 4 comments
Open

inline doesn't need to be documented #917

cjdb opened this issue May 16, 2023 · 4 comments
Labels
enhancement Improvements, additions (also cosmetics)

Comments

@cjdb
Copy link

cjdb commented May 16, 2023

inline isn't a part of the interface, so including it as a part of the API documentation adds noise (especially when something is marked constexpr, which implies inline anyway).

@vermeeren
Copy link
Collaborator

@cjdb In some way yes, in another way showing things exactly as-is I feel is good for transparency. Could add a global Breathe configuration option to hide inline, though it might also be added by Sphinx's C/C++ domain, I'm not sure.

Patches welcome!

@vermeeren vermeeren added the enhancement Improvements, additions (also cosmetics) label May 16, 2023
@cjdb
Copy link
Author

cjdb commented May 16, 2023

This looks fairly straightforward to patch, ETA tomorrow :)

@emilydolson
Copy link

Any progress on this? I just updated Breath and Sphinx and suddenly I've got inlines everywhere. I'd love to get rid of them (and I think its also possible some of them are erroneous, but I'm not sure).

@cjdb
Copy link
Author

cjdb commented Jun 13, 2023

I have a local patch, but I'm going to wait until #918 is merged before making further contributions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvements, additions (also cosmetics)
Projects
None yet
Development

No branches or pull requests

3 participants