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.

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

Make our doctools submodule more robust #467

Merged
merged 3 commits into from
Apr 8, 2020
Merged

Make our doctools submodule more robust #467

merged 3 commits into from
Apr 8, 2020

Conversation

mpenkov
Copy link
Collaborator

@mpenkov mpenkov commented Apr 7, 2020 •
edited
Loading

  • Moved all docstring-related functionality into the doctools submodule
  • Make submodules document themselves (use the first line of the docstring to explain what that submodule does, e.g. handle AWS S3)
  • Guard against problems in docstring manipulation with general exception (except Exception)
  • Add documentation of parse_uri to help

@mpenkov mpenkov requested review from piskvorky and menshikh-iv and removed request for piskvorky April 7, 2020 13:02
piskvorky
piskvorky reviewed Apr 7, 2020
View reviewed changes
Copy link
Owner

@piskvorky piskvorky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting idea! Have you seen this approach elsewhere, or your own creation?

help.txt
-----
Supported URI schemes are:

* file
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* file
* file (default, used when no scheme specified)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I gradually came up with this from scratch myself, but I'm sure it has been done before (e.g. self-documenting plugins).

help.txt Show resolved Hide resolved
@mpenkov mpenkov merged commit 160eb81 into piskvorky:master Apr 8, 2020
@mpenkov mpenkov deleted the doctools-fixup branch April 8, 2020 08:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@piskvorky piskvorky piskvorky left review comments

@menshikh-iv menshikh-iv menshikh-iv approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mpenkov @piskvorky @menshikh-iv