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

Small RST tweaks to docstrings #10106

Merged
merged 3 commits into from
Apr 3, 2020
Merged

Small RST tweaks to docstrings #10106

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift click to select a range
ac3ef74
Backticks to avoid unclosed bold in RST
peterjc Apr 3, 2020
45d7264
RST literal block
peterjc Apr 3, 2020
901dc03
Add consistency
bsipocz Apr 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Backticks to avoid unclosed bold in RST
  • Loading branch information
@peterjc
peterjc committed Apr 3, 2020
commit ac3ef74a9bb262abbfac44b76a077d00bc36a677
2 changes: 1 addition & 1 deletion astropy/modeling/tests/test_fitters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -884,7 884,7 @@ def test_fitters_with_weights():
@pytest.mark.filterwarnings('ignore:The fit may be unsuccessful')
def test_fitters_interface():
"""
Test that **kwargs work with all optimizers.
Test that ``**kwargs`` work with all optimizers.
This is a basic smoke test.
"""
levmar = LevMarLSQFitter()
Expand Down
10 changes: 5 additions & 5 deletions astropy/time/tests/test_methods.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,9 317,9 @@ def setup(self):
@pytest.mark.parametrize('kw, func', itertools.product(kwargs, functions))
def test_argfuncs(self, kw, func, masked):
"""
Test that np.argfunc(jd, **kw) is the same as t0.argfunc(**kw) where
jd is a similarly shaped array with the same ordinal properties but
all integer values. Also test the same for t1 which has the same
Test that ``np.argfunc(jd, **kw)`` is the same as ``t0.argfunc(**kw)``
where jd is a similarly shaped array with the same ordinal properties
bsipocz marked this conversation as resolved.
Show resolved Hide resolved
but all integer values. Also test the same for t1 which has the same
integral values as jd.
"""
t0v = getattr(self.t0, 'arg' func)(**kw)
Expand All @@ -339,8 339,8 @@ def test_argfuncs(self, kw, func, masked):
@pytest.mark.parametrize('kw, func', itertools.product(kwargs, functions))
def test_funcs(self, kw, func, masked):
"""
Test that np.func(jd, **kw) is the same as t1.func(**kw) where
jd is a similarly shaped array and the same integral values.
Test that ``np.func(jd, **kw)`` is the same as ``t1.func(**kw)`` where
``jd`` is a similarly shaped array and the same integral values.
"""
t1v = getattr(self.t1, func)(**kw)
jdv = getattr(np, func)(self.jd, **kw)
Expand Down