add title/description fields #754
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## dev #754 +/- ##
==========================================
- Coverage 98.16% 97.70% -0.47%
==========================================
Files 45 45
Lines 3975 4006 +31
==========================================
+ Hits 3902 3914 +12
- Misses 73 92 +19
Continue to review full report at Codecov.
|
|
thanks @smackesey ! would you mind rebasing your changes onto |
smackesey
force-pushed
the
add-descriptions
branch
from
0a94c97
to
907954b
Compare
cosmicBboy
reviewed
Feb 3, 2022
|
unit tests are looking good!
Are you planning to address this in another PR? |
Up to you how to handle this. I posted this PR without adding these "secondary" items because I didn't really know whether they were necessary and/or the right approach. Projects have different approaches to testing/docs and it can be difficult to know where to add without a global understanding. Sometimes it makes sense for a contributor to add the core code for a feature and a maintainer to fill in this secondary materials. But, I can add them in this PR if you like. Let me get more specific with questions:
|
|
I think the auto-docs in the API reference should be enough for this. re: tests, the only thing to add here would be to update
Agreed, #695 should address this |
cosmicBboy
reviewed
Feb 4, 2022
|
merging this now, thanks @smackesey ! |
cosmicBboy
added a commit
that referenced
this pull request
Feb 8, 2022
* Geopandas (#732) * Add support for geopandas GeometryDtype (#698) * Add geopandas support * small tweak * linting * requirements * fixes * import variable * fin * too many ancestors * ok actually please be done * Update geopandas.py * Update geopandas.py Co-authored-by: Niels Bantilan <niels.bantilan@gmail.com> * geopandas docs (#711) * geopandas docs * links * geopandas unit tests, more docs (#731) * ci doesn't install geopandas on windows * update strategies tests * update strategies tests * update tests * update docs * pin sphinx-autodoc-typehints=1.14.1 error in importing Literal in python 3.7 * exclude check docs from windows os build Co-authored-by: Roshan A <roshan.agrawal95@gmail.com> * typed descriptors and setup.py only includes pandera (#739) * typed descriptors and setup.py only includes pandera * black * Update common.py Co-authored-by: Niels Bantilan <niels.bantilan@gmail.com> * Bugfix/734 (#735) * fix error-reporting bug for pandas==1.1.5 * add tests, add pandas 1.1.5 to CI * fix ci conditional on modin * simplify error formatting logic * Fastapi initial integration (#741) * fastapi support * wip * [wip] add pre/post_format * implement pre/post-format semantics on check_types * rename from/to format config and methods * pa.check_types uses pydantic.validate_arguments * update tests * add check_types(use_pydantic:bool) flag * rename arg to with_pydantic * add tests for format conversion * add happy path fastapi tests * fix Literal import * fix deps * remove prototyping files * fix lint * fix typing.fastapi module imports * ignore mypy errors * fix set_index with MultiIndex (#751) * strategies: correctly handle StringArray null values (#748) * strategies: correctly handle StringArray null values * handle pandas 1.1.5 and 1.4.0 errors * Add Python 3.10 to CI matrix (#724) * Add Python 3.10 to CI * Fix CI * Exclude modin tests on Python 3.10 * Exclude ray from Python 3.10 build * Exclude modin-ray from Python 3.10 build * Fix environment.yml version of ray * exclude ray from base deps installation * Update .github/workflows/ci-tests.yml * Update .github/workflows/ci-tests.yml * fix ci and setup.py * update deps * update deps, nox * update ci, noxfile * update ci * simplify nox linters * exclude geopandas in py310 * update nox * update black version * update reqs * update readthedocs py version * dont install koalas for py310 * update readthedocs py version * update deps * test readthedocs * add back ci tests * windows * update pandas version in nox * remove koalas + windows * fix ci file * ignore windows doc checks * add back other os * dont build docs for py3.10 * test ubuntu * set max parallel * try no-env * try no-env * testing * testing * get python version from sys * upgrade pip * pytest verbosity * add back cache * bump cache version * testing * testing * update * try using conda * update conda setup * update conda setup * use conda * unpin numpy * update reqs * only use conda-forge * update * update * use pip * use pip * testing * install numpy * increase cache * update * test nox * cache pip * use nox * use nox * update * testing * testing * testing * testing * testing * testing * testing * testing * testing * testing * add matrix * disable koalas in ci * update * testing * testing * testing * testing * testing * testing * use nox * use pytest * testing * clean up Co-authored-by: Niels Bantilan <niels.bantilan@gmail.com> * fastapi docs, add to ci (#753) * fastapi docs, add to ci * add data conversion docs page, sponsor button * fix lint * update requirements file * fix mypy test * update deps * fix tests * fix docs deps * update docs copy * more docs copy updates * formatting * fix yml * add title/description fields (#754) * add title/description fields * modify base config with title/desc * fix docstring * black * let SchemaModel use docstring as desc * update test_config * fix black * Update tests/core/test_model.py * fix black Co-authored-by: Niels Bantilan <niels.bantilan@gmail.com> * Pull request: Nullable float (#721) * New datatype: Panda's (ver 1.2.0+) nullable float. Documentation: https://pandas.pydata.org/pandas-docs/stable/whatsnew/v1.2.0.html?highlight=float64dtype#experimental-nullable-data-types-for-float-data * PyLint expects uppercase snake case. * fix unit test * fix docs * fix fastapi tests Co-authored-by: Vova <vladimirvilimaitis@gmail.com> Co-authored-by: cosmicBboy <niels.bantilan@gmail.com> Co-authored-by: Roshan A <roshan.agrawal95@gmail.com> Co-authored-by: Cristian Matache <cristianmatache@hotmail.com> Co-authored-by: James Myatt <james@jamesmyatt.co.uk> Co-authored-by: Sean Mackesey <s.mackesey@gmail.com> Co-authored-by: vovavili <64227274+vovavili@users.noreply.github.com> Co-authored-by: Vova <vladimirvilimaitis@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses #728
Right now it's just a start, but my manual (not very thorough testing) indicates that it's working.
Other things that should probably be added/modified:
Also, I had some failing tests but I don't think these are related to this PR: