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

Refactor to default role obj #1091

Merged
merged 1 commit into from
Jun 9, 2019

Conversation

bengartner
Copy link
Contributor

Issue #78

Set default_role to obj and refactored out existing :obj: tags. Fixed 3 sphinx warnings for unresolved references and spot checked the docs. I did NOT look at all the defaults being parsed by sphinx, so it's possible some of them have silently changed meaning. I guess the way to check this would be to diff the html output and make sure it's small?

@njsmith
Copy link
Member

njsmith commented Jun 9, 2019

I guess the way to check this would be to diff the html output and make sure it's small?

I'm not super worried, but if you do this then I bet you'll learn something one way or the other :-)

There are also a lot of places in the docs where we use explicit role markers like :class:`trio.Lock` , that could become a plain `trio.Lock` instead. That doesn't necessarily have to happen as part of this PR, and maybe it's better if it doesn't. But that's where we'll get most of the benefit from having default_role = "obj"

@bengartner
Copy link
Contributor Author

Diff was small!

@njsmith
Copy link
Member

njsmith commented Jun 9, 2019

OK, let's put this in and we can worry about reducing :class:/:meth:/etc clutter in followups

I'm also sending a github invite, as described in our contributing documentation. You're not obligated to accept, but we'd certainly love to have you :-)

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

Successfully merging this pull request may close these issues.

2 participants