From 7fbe62eb5ea7dacaa3432cc6b06b7742ce6bfcaa Mon Sep 17 00:00:00 2001 From: mozman Date: Wed, 13 Sep 2023 08:39:37 +0200 Subject: [PATCH] edit docs --- README.md | 13 +++++++------ src/ezdxf/__init__.py | 12 +++++++++++- 2 files changed, 18 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 565f1dc96..ca62c4687 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,13 @@ ezdxf Abstract -------- -This Python package is for creating and modifying DXF documents, regardless of -the DXF version. The package supports loading and rewriting DXF file without -losing any content except comments. -Unknown DXF tags in the document are ignored but kept for rewriting. -This behavior allows processing DXF documents that contain data from third-party -applications without loosing information. +This Python package is designed to facilitate the creation and manipulation of DXF +documents, with compatibility across various DXF versions. It empowers users to +seamlessly load and edit DXF files while preserving all content, except for comments. + +Any unfamiliar DXF tags encountered in the document are gracefully ignored but retained +for future modifications. This feature enables the processing of DXF documents +containing data from third-party applications without any loss of valuable information. Quick-Info ---------- diff --git a/src/ezdxf/__init__.py b/src/ezdxf/__init__.py index 0837eb622..fc3ee44b4 100644 --- a/src/ezdxf/__init__.py +++ b/src/ezdxf/__init__.py @@ -1,5 +1,15 @@ -# Copyright (C) 2011-2021, Manfred Moitzi +# Copyright (C) 2011-2023, Manfred Moitzi # License: MIT License +"""Ezdxf is an interface library for the DXF file format. + +The package is designed to facilitate the creation and manipulation of DXF +documents, with compatibility across various DXF versions. It empowers users to +seamlessly load and edit DXF files while preserving all content, except for comments. + +Any unfamiliar DXF tags encountered in the document are gracefully ignored but retained +for future modifications. This feature enables the processing of DXF documents +containing data from third-party applications without any loss of valuable information. +""" from typing import TextIO, Optional import sys import os