Skip to content

Clarify docs and keep legacy doctests runnable#23

Open
kajbaf wants to merge 9 commits into
brandonschabell:mainfrom
kajbaf:feature/improve-readme
Open

Clarify docs and keep legacy doctests runnable#23
kajbaf wants to merge 9 commits into
brandonschabell:mainfrom
kajbaf:feature/improve-readme

Conversation

@kajbaf
Copy link
Copy Markdown
Contributor

@kajbaf kajbaf commented Oct 26, 2025 •
edited
Loading

  • rewrote README to highlight key URLPath features and corrected the jailed WebOb example
  • moved the old doctest snippets into doctests.md with context so contributors know they still run
  • updated the Makefile to reference the new doctest file via DOC_TESTS and refreshed target descriptions

@kajbaf kajbaf changed the title Clear readme Clarify docs and keep legacy doctests runnable Oct 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@kajbaf