📚 add usage warning (#44)

* 📚 add usage warning

* This is an auto-commit, updating project meta data, such as changelog.rst, contributors.rst

* 📚 update readme

* ✨ use pat

Co-authored-by: chfw <[email protected]>

Author: chfw

.github/workflows/moban-update.yml

@@ -8,6 +8,7 @@ jobs:
       - uses: actions/checkout@v2
         with:
           ref: ${{ github.head_ref }}
+          token: ${{ secrets.PAT }}
       - name: Set up Python
         uses: actions/setup-python@v1
         with:

.moban.d/custom_README.rst.jj2

@@ -4,11 +4,26 @@
 {% endblock %}
 
 {%block description%}
-**pyexcel-{{file_type}}** is a tiny wrapper library to read, manipulate and write data in {{file_type}} format and it can read xlsx and xlsm fromat. You are likely to use it with `pyexcel <https://github.com/pyexcel/pyexcel>`_.
+**pyexcel-{{file_type}}** is a tiny wrapper library to read, manipulate and
+write data in {{file_type}} format and it can read xlsx and xlsm fromat.
+You are likely to use it with `pyexcel <https://github.com/pyexcel/pyexcel>`_.
 
-New flag: `detect_merged_cells` allows you to spread the same value among all merged cells. But be aware that this may slow down its reading performance.
+New flag: `detect_merged_cells` allows you to spread the same value among
+all merged cells. But be aware that this may slow down its reading
+performance.
 
-New flag: `skip_hidden_row_and_column` allows you to skip hidden rows and columns and is defaulted to **True**. It may slow down its reading performance. And it is only valid for 'xls' files. For 'xlsx' files, please use pyexcel-xlsx.
+New flag: `skip_hidden_row_and_column` allows you to skip hidden rows
+and columns and is defaulted to **True**. It may slow down its reading
+performance. And it is only valid for 'xls' files. For 'xlsx' files,
+please use pyexcel-xlsx.
+
+Warning
+================================================================================
+
+xls file cannot contain more than 65,000 rows. You are risking the reputation
+of yourself/your company/
+`your country <https://www.bbc.co.uk/news/technology-54423988>`_ if you keep
+using xls and are not aware of its row limit.
 
 {%endblock%}
 

README.rst

@@ -35,11 +35,26 @@ pyexcel-xls - Let you focus on data, instead of xls format
 .. image:: https://img.shields.io/static/v1?label=coding%20style&message=black&color=black&style=flat-square
     :target: https://github.com/psf/black
 
-**pyexcel-xls** is a tiny wrapper library to read, manipulate and write data in xls format and it can read xlsx and xlsm fromat. You are likely to use it with `pyexcel <https://github.com/pyexcel/pyexcel>`_.
+**pyexcel-xls** is a tiny wrapper library to read, manipulate and
+write data in xls format and it can read xlsx and xlsm fromat.
+You are likely to use it with `pyexcel <https://github.com/pyexcel/pyexcel>`_.
 
-New flag: `detect_merged_cells` allows you to spread the same value among all merged cells. But be aware that this may slow down its reading performance.
+New flag: `detect_merged_cells` allows you to spread the same value among
+all merged cells. But be aware that this may slow down its reading
+performance.
 
-New flag: `skip_hidden_row_and_column` allows you to skip hidden rows and columns and is defaulted to **True**. It may slow down its reading performance. And it is only valid for 'xls' files. For 'xlsx' files, please use pyexcel-xlsx.
+New flag: `skip_hidden_row_and_column` allows you to skip hidden rows
+and columns and is defaulted to **True**. It may slow down its reading
+performance. And it is only valid for 'xls' files. For 'xlsx' files,
+please use pyexcel-xlsx.
+
+Warning
+================================================================================
+
+xls file cannot contain more than 65,000 rows. You are risking the reputation
+of yourself/your company/
+`your country <https://www.bbc.co.uk/news/technology-54423988>`_ if you keep
+using xls and are not aware of its row limit.
 
 
 Support the project