[yt-svn] commit/yt: MatthewTurk: Quick fixes to docstrings
commits-noreply at bitbucket.org
commits-noreply at bitbucket.org
Fri Mar 1 07:33:55 PST 2013
1 new commit in yt:
https://bitbucket.org/yt_analysis/yt/commits/66cfa80521d8/
changeset: 66cfa80521d8
branch: yt
user: MatthewTurk
date: 2013-03-01 16:28:18
summary: Quick fixes to docstrings
affected #: 8 files
diff -r 4b6df9661b7c1e5709308432d4f76f2f151fc3ac -r 66cfa80521d8a583b984b53306f35994790a6e86 yt/analysis_modules/cosmological_observation/light_ray/light_ray.py
--- a/yt/analysis_modules/cosmological_observation/light_ray/light_ray.py
+++ b/yt/analysis_modules/cosmological_observation/light_ray/light_ray.py
@@ -244,8 +244,9 @@
If True, use dynamic load balancing to create the projections.
Default: False.
- Getting the Nearest Galaxies
- ----------------------------
+ Notes
+ -----
+
The light ray tool will use the HaloProfiler to calculate the
distance and mass of the nearest halo to that pixel. In order
to do this, a dictionary called halo_profiler_parameters is used
diff -r 4b6df9661b7c1e5709308432d4f76f2f151fc3ac -r 66cfa80521d8a583b984b53306f35994790a6e86 yt/analysis_modules/halo_merger_tree/enzofof_merger_tree.py
--- a/yt/analysis_modules/halo_merger_tree/enzofof_merger_tree.py
+++ b/yt/analysis_modules/halo_merger_tree/enzofof_merger_tree.py
@@ -454,8 +454,8 @@
halonum : int
Halo number at the last output to trace.
- Output
- ------
+ Returns
+ -------
output : dict
Dictionary of redshifts, cycle numbers, and halo numbers
of the most massive progenitor. keys = {redshift, cycle,
diff -r 4b6df9661b7c1e5709308432d4f76f2f151fc3ac -r 66cfa80521d8a583b984b53306f35994790a6e86 yt/analysis_modules/halo_merger_tree/merger_tree.py
--- a/yt/analysis_modules/halo_merger_tree/merger_tree.py
+++ b/yt/analysis_modules/halo_merger_tree/merger_tree.py
@@ -758,17 +758,19 @@
def query(self, string):
r"""Performs a query of the database and returns the results as a list
- of tuple(s), even if the result is singular.
+ of tuples, even if the result is singular.
Parameters
----------
- string : String
+
+ string : str
The SQL query of the database.
Examples
- -------
+ --------
+
>>> results = mtc.query("SELECT GlobalHaloID from Halos where SnapHaloID = 0 and \
- ... SnapZ = 0;")
+ ... SnapZ = 0;")
"""
# Query the database and return a list of tuples.
if string is None:
diff -r 4b6df9661b7c1e5709308432d4f76f2f151fc3ac -r 66cfa80521d8a583b984b53306f35994790a6e86 yt/analysis_modules/halo_profiler/multi_halo_profiler.py
--- a/yt/analysis_modules/halo_profiler/multi_halo_profiler.py
+++ b/yt/analysis_modules/halo_profiler/multi_halo_profiler.py
@@ -430,8 +430,8 @@
After all the calls to `add_profile`, this will trigger the actual
calculations and output the profiles to disk.
- Paramters
- ---------
+ Parameters
+ ----------
filename : str
If set, a file will be written with all of the filtered halos
diff -r 4b6df9661b7c1e5709308432d4f76f2f151fc3ac -r 66cfa80521d8a583b984b53306f35994790a6e86 yt/analysis_modules/spectral_integrator/spectral_frequency_integrator.py
--- a/yt/analysis_modules/spectral_integrator/spectral_frequency_integrator.py
+++ b/yt/analysis_modules/spectral_integrator/spectral_frequency_integrator.py
@@ -60,9 +60,9 @@
Initialize an EmissivityIntegrator object.
- Keyword Parameters
- ------------------
- filename: string
+ Parameters
+ ----------
+ filename: string, default None
Path to data file containing emissivity values. If None,
a file called xray_emissivity.h5 is used. This file contains
emissivity tables for primordial elements and for metals at
@@ -146,8 +146,8 @@
e_min: float
the maximum energy in keV for the energy band.
- Keyword Parameters
- ------------------
+ Other Parameters
+ ----------------
filename: string
Path to data file containing emissivity values. If None,
a file called xray_emissivity.h5 is used. This file contains
@@ -220,8 +220,8 @@
e_min: float
the maximum energy in keV for the energy band.
- Keyword Parameters
- ------------------
+ Other Parameters
+ ----------------
filename: string
Path to data file containing emissivity values. If None,
a file called xray_emissivity.h5 is used. This file contains
@@ -277,8 +277,8 @@
e_min: float
the maximum energy in keV for the energy band.
- Keyword Parameters
- ------------------
+ Other Parameters
+ ----------------
filename: string
Path to data file containing emissivity values. If None,
a file called xray_emissivity.h5 is used. This file contains
diff -r 4b6df9661b7c1e5709308432d4f76f2f151fc3ac -r 66cfa80521d8a583b984b53306f35994790a6e86 yt/data_objects/data_containers.py
--- a/yt/data_objects/data_containers.py
+++ b/yt/data_objects/data_containers.py
@@ -3875,10 +3875,11 @@
fields : array_like, optional
A list of fields that you'd like pre-generated for your object
- Example
- -------
- cube = pf.h.smoothed_covering_grid(2, left_edge=[0.0, 0.0, 0.0], \
- dims=[128, 128, 128])
+ Examples
+ --------
+
+ >>> cube = pf.h.smoothed_covering_grid(2, left_edge=[0.0, 0.0, 0.0], \
+ ... dims=[128, 128, 128])
"""
_type_name = "smoothed_covering_grid"
def __init__(self, *args, **kwargs):
diff -r 4b6df9661b7c1e5709308432d4f76f2f151fc3ac -r 66cfa80521d8a583b984b53306f35994790a6e86 yt/testing.py
--- a/yt/testing.py
+++ b/yt/testing.py
@@ -193,8 +193,8 @@
Returns
-------
array of dicts
- An array of **kwargs dictionaries to be individually passed to
- the appropriate function matching these kwargs.
+ An array of dictionaries to be individually passed to the appropriate
+ function matching these kwargs.
Examples
--------
diff -r 4b6df9661b7c1e5709308432d4f76f2f151fc3ac -r 66cfa80521d8a583b984b53306f35994790a6e86 yt/visualization/plot_window.py
--- a/yt/visualization/plot_window.py
+++ b/yt/visualization/plot_window.py
@@ -644,8 +644,8 @@
the new maximum of the colormap scale. If 'max', will
set to the maximum value in the current view.
- Keyword Parameters
- ------------------
+ Other Parameters
+ ----------------
dyanmic_range : float (default: None)
The dynamic range of the image.
If zmin == None, will set zmin = zmax / dynamic_range
@@ -972,8 +972,8 @@
manager documentation for more details.
http://matplotlib.org/api/font_manager_api.html
- Caveats
- -------
+ Notes
+ -----
Mathtext axis labels will only obey the `size` keyword.
Examples
Repository URL: https://bitbucket.org/yt_analysis/yt/
--
This is a commit notification from bitbucket.org. You are receiving
this because you have the service enabled, addressing the recipient of
this email.
More information about the yt-svn
mailing list