search

avakar / pycson

A Coffescript Object Notation (CSON) parser for Python 2 and Python 3.
Other
55 stars 7 forks source link

Improve help(cson) #13

Closed marcospb19 closed 4 years ago

marcospb19 commented 4 years ago

Hey, I really appreciate your software.

To make cson more easy to use, could you improve the help() text?

import cson
help(cson)

Outputs:

Help on package cson:

NAME cson

PACKAGE CONTENTS parser writer

FILE /usr/lib/python3.8/site-packages/cson/init.py

It would be nice if at least there is a link to your repository, where we can find the following note:

The interface is the same as for the standard json package.

marcospb19 commented 4 years ago

As I observed, other packages like mypy and pyyaml don't have the documentation set there, but those are packages easier to find.

My concern of doing this was because there is another pycson package, and people might get confused.