Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Numpy docstrings api #253

Merged
merged 81 commits into from Oct 6, 2021
Merged

Numpy docstrings api #253

merged 81 commits into from Oct 6, 2021

Conversation

dccowan
Copy link
Member

@dccowan dccowan commented Jun 18, 2021 •
edited

Pull Request for Discretize Docstrings

  • Global reorganization of autogenerated API
  • Numpy style docstrings for each property, method, function and class
  • Include examples within docstrings whenever possible/necessary

Some remaining items

  • How much information do we want to put in docstrings for differential operators?
    • How much mathematical detail?
    • How much detail regarding how the operator is constructed?
    • What type of image or example to illustrate?

dccowan and others added 30 commits October 13, 2020 15:51
@dccowan
coordinate and interpolation utils docstrings update
f51c1f5
@dccowan
More docstrings and examples added
018e44d
@dccowan
Finish mesh utils and fix syntax errors in docstrings
8e7042e
@dccowan
Update some syntax. Add example. Change method name to 'closest_point…
10e46ee 
…s_index'
@dccowan
Update closest points function. Add examples and docstrings for inver…
c384a7a 
…t 2x2 and 3x3 matricies
@dccowan
Fix syntax for defining parameters. Added some math to docstrings and…
a10b54b 
… added some examples.
@dccowan
Merge branch 'restructure' into numpy_docstrings_api
8e57079 
# Conflicts:
#	discretize/utils/mesh_utils.py
#	docs/api/index.rst
@dccowan
Merge branch 'restructure' into numpy_docstrings_api
b0d3b13
@dccowan
Add more docstrings to base mesh and base tensor mesh
6313d6d
@dccowan
Add docstrings to tensor mesh
f05e70c
@dccowan
Merge branch 'restructure' into numpy_docstrings_api
b51ed4d 
# Conflicts:
#	discretize/base/base_mesh.py
#	discretize/base/base_tensor_mesh.py
#	discretize/tensor_mesh.py
@jcapriot
switch for a pydata sphinx theme, and move around some items.
cee7c74
@jcapriot
updates for formatting
ffb4f58
@jcapriot
Merge branch 'de-prop' into pydata_retheme
0d667eb 
# Conflicts:
#	discretize/base/base_mesh.py
#	discretize/mixins/vtk_mod.py
@jcapriot
Merge branch 'de-prop' into pydata_retheme
cfd5aa9
@jcapriot
apply stash
e86c02e
@jcapriot
updating documentation for base_mesh
8cea4ea
@jcapriot
update documentation of BaseMesh
ff6e4eb
@jcapriot
make deprecate_* functions include a See Also link
8b51db9
@jcapriot
put links to examples/tutorials back in for classes.
7d351d2
@jcapriot
Merge branch 'de-prop' into pydata_retheme
645d95d
@dccowan
Merge branch 'master' into numpy_docstrings_api
9cb0016
@dccowan
Merge branch 'de-prop' into numpy_docstrings_api
8de2448 
# Conflicts:
#	discretize/base/base_mesh.py
@dccowan
update some docstrings
cd71b14
@jcapriot
Merge branch 'de-prop' into pydata_retheme
27a2ea0
@dccowan
Merge branch 'pydata_retheme' into numpy_docstrings_api
2961d3e 
# Conflicts:
#	docs/api/index.rst
@dccowan
some global api organization
64beea3
@dccowan
Merge branch 'de-prop' into numpy_docstrings_api
f2f4a20
@jcapriot
Merge branch 'main' into pydata_retheme
25030f4 
# Conflicts:
#	discretize/base/base_mesh.py
@jcapriot
Merge branch 'pydata_retheme' into numpy_docstrings_api
dc7e335 
# Conflicts:
#	discretize/base/base_tensor_mesh.py
#	discretize/curvilinear_mesh.py
#	discretize/utils/mesh_utils.py
dccowan and others added 26 commits July 21, 2021 09:51
@dccowan
Fix grammar and some examples
44e2868
@dccowan
Update link check to look at platform
6c16fb4
@dccowan
add import platform
972d05f
@jcapriot
formatting updates
e46b7e3
@jcapriot
More cleanups
e4defc0
@jcapriot
no message
c3e1233
@jcapriot
undo doc test change for linux/mac
cef8554
@jcapriot
intersphinx update
e98fb73
@jcapriot
formatting updates
cd3cec1
@jcapriot
update navbar icon colors
2000636
@jcapriot
minor mixin edits
dd95fd4
@jcapriot
master -> main
3f096b0
@jcapriot
Add at least a line of text to each of these introducing the section.
b1c089f
@jcapriot
update the installation recommendation for current best practices
f4b9c57
@jcapriot
some more formatting updates
c753649 
Now uses graphviz to create inheritence diagrams at the beginning of each class (instead of :show-inheritence:)
@jcapriot
remove old documentation config options
d60680e
@jcapriot
add graphviz to the documentation build option (for 3.8)
f500359
@jcapriot
add 3.9 to windows wheel build
5d29b35
@jcapriot
update some wording on these two landing pages.
9992897
@jcapriot
update incorrect references to classes in discretize.base
f963275
@jcapriot
add conda-forge badge
128c475
@dccowan
Merge pull request #258 from jcapriot/numpy_docstrings_api_review
66bf256 
Numpy docstrings api review
@dccowan
add pydata theme to dev requirements
b98a184
@dccowan
Use toolbox collapse extension for long plotting scripts
b217e92
@jcapriot
add sphinx-toolbox to the requirements-dev file
b3165b3
@jcapriot
updates for deprecations in pyvista
3bdd8a6
@jcapriot jcapriot merged commit 7b14334 into main Oct 6, 2021
@jcapriot jcapriot deleted the numpy_docstrings_api branch October 6, 2021 00:00
@jcapriot jcapriot restored the numpy_docstrings_api branch October 6, 2021 00:09
@jcapriot jcapriot deleted the numpy_docstrings_api branch October 6, 2021 00:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jcapriot jcapriot Awaiting requested review from jcapriot

Assignees
No one assigned
Labels
in progress
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@dccowan @jcapriot