Skip to content

Conversation

@jonhadfield
Copy link
Owner

Summary

  • expand README with more examples
  • elaborate usage guide with additional features

Testing

  • pytest -q

https://chatgpt.com/codex/tasks/task_e_685ab373869c8320a5901d3f35256ea9

Copilot AI review requested due to automatic review settings June 24, 2025 15:17
@jonhadfield jonhadfield merged commit d3820c6 into devel Jun 24, 2025
0 of 16 checks passed
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR expands and clarifies the project documentation by enriching the README and the detailed usage guide.

  • Adds query and merge examples to README
  • Introduces “Basic operations” and “Additional features” sections in docs/usage.rst

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
docs/usage.rst Added structured “Basic operations” and “Additional features” blocks
README.md Updated library summary, added query/merge examples
Comments suppressed due to low confidence (2)

README.md:7

  • [nitpick] Consider adding a comma before “and query existing entries” for clarity: “import them from a file or URL, and query existing entries.”
It enables you to add and remove entries, import them from a file or URL and

README.md:46

  • This snippet uses HostsEntry but does not show its import; consider adding from python_hosts import HostsEntry or referencing the earlier import for completeness.
    new_entry = HostsEntry(entry_type='ipv4', address='1.2.3.4', names=['alias'])

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants