Skip to content

Commit

Permalink
Squash some more code issues
Browse files Browse the repository at this point in the history
  • Loading branch information
gb119 committed Dec 21, 2024
1 parent 6ff7b6d commit 0bd8eca
Show file tree
Hide file tree
Showing 8 changed files with 9 additions and 12 deletions.
16 changes: 8 additions & 8 deletions docs/TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,35 +5,35 @@ Docstrings should be written in ReStructured Text format.

## General Structure

1. **Short Summary**
1. **Short Summary**
- A brief description of the class or method functionality.
- This should include a one line summary written as an imperitive satement,
followed by a longer summary of the purpose of the class, function or method.
- The on line summary should start on the openning """" of the docstring.
2. **Args**
2. **Args**
- A section describing the positional parameters in order.
- Each parameter should be described following the format:
`parameter_name (type): Description of what the parameter represents.`
- If the description takes more than the remainder of the line, it should
form a short block.
3. **Keyword Parameters**
3. **Keyword Parameters**
- A section describing the keyword parameters.
- Each keyword parameter should be described following the format:
- `parameter_name (type): Description of what the parameter represents.`
and the default value.`
3. **Attributes**
3. **Attributes**
- Provide brief explanations for key internal class attributes:
`attribute_name (type): Description.`
4. **Raises**
4. **Raises**
- Provide a list of any Exceptions that are eplicitly raised with a
brief description of the circumstances in which they are raise.
5. **Returns**
5. **Returns**
- Indicate the return type of the function or method.
- Give a brief description of the return value.
6. **Notes**
6. **Notes**
- Explain important implementation details, gotchas, or assumptions.
- THis section may be omitted if there are no important details or gotchas.
5. **Examples**
5. **Examples**
- Include real-world examples of how to use the functionality, both basic and advanced.
- This section may be omitted for functions, methods and classes that are not intended
for third parties to use - for example, base classes, internal or private functions or methods.
Expand Down
Binary file modified examples/figures/fig02b.pdf
Binary file not shown.
Binary file modified examples/figures/fig02h_1.pdf
Binary file not shown.
Binary file modified examples/figures/fig02h_2.pdf
Binary file not shown.
Binary file modified examples/figures/fig03.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified examples/figures/fig05f.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added examples/figures/fig05g.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 1 addition & 4 deletions src/stonerplots/context.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,6 @@
import numpy as np
from mpl_toolkits.axes_grid1.inset_locator import inset_axes

# Project-specific imports
from stonerplots import * # NOQA:

from .util import find_best_position, move_inset, new_bbox_for_loc

__all__ = ["SavedFigure", "InsetPlot", "StackVertical", "MultiPanel", "counter", "roman"]
Expand Down Expand Up @@ -988,7 +985,7 @@ def __enter__(self):
)
return super().__enter__()

def __exit__(self, type, value, traceback):
def __exit__(self, exc_type, value, traceback):
"""Clean up and adjust the subplot layout upon exiting the context."""
if self.joined:
for ax in self.axes:
Expand Down

0 comments on commit 0bd8eca

Please sign in to comment.