From 599bd84fb97643a5a55c0fa3aac48f2105ab18bc Mon Sep 17 00:00:00 2001
From: Joseph Weston <joseph.weston08@gmail.com>
Date: Thu, 15 Feb 2018 16:17:04 +0100
Subject: [PATCH] fix return type of Builder.finalize() to concrete subclass
While we *may* choose only to specify that finalize() returns
a system.Finitesystem (or system.InfiniteSystem), this is probably
a bad idea, as the docstring of finalize() is the only place that
people can find out about builder.FiniteSystem (which contains
the documentation for the 'sites' attribute, for example).
---
kwant/builder.py | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/kwant/builder.py b/kwant/builder.py
index 79934b76..49407e07 100644
--- a/kwant/builder.py
+++ b/kwant/builder.py
@@ -1606,9 +1606,9 @@ class Builder:
Returns
-------
- finalized_system : `kwant.system.FiniteSystem`
+ finalized_system : `kwant.builder.FiniteSystem`
If there is no symmetry.
- finalized_system : `kwant.system.InfiniteSystem`
+ finalized_system : `kwant.builder.InfiniteSystem`
If a symmetry is present.
Notes
--
GitLab