Skip to content

Commit b09a84c

Browse files
committed
Miscellaneous documentation fixes for source links and pin Ford to latest version.
1 parent e787c98 commit b09a84c

3 files changed

Lines changed: 9 additions & 9 deletions

File tree

pages/usage/tensor.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,15 +88,15 @@ the other methods (simply drop the preceding `torch_tensor_`).
8888
#### Deallocation
8989

9090
We provide a subroutine for deallocating the memory associated with a
91-
[[ftorch(module):torch_tensor(type)]] object:
92-
[[ftorch(module):torch_tensor_delete(subroutine)]]. An interface
91+
[[ftorch_tensor(module):torch_tensor(type)]] object:
92+
[[ftorch_tensor(module):torch_tensor_delete(subroutine)]]. An interface
9393
[[ftorch(module):torch_delete(interface)]] is provided such that this can also
9494
be applied to arrays of tensors.
9595

9696
Manually deallocating a tensor that you declared and constructed in your code is
9797
actually optional. If the tensor was declared in a subroutine then
98-
[[ftorch(module):torch_tensor_delete(subroutine)]] will get called as the
99-
finalizer of [[ftorch(module):torch_tensor(type)]] when it goes out of scope. If
98+
[[ftorch_tensor(module):torch_tensor_delete(subroutine)]] will get called as the
99+
finalizer of [[ftorch_tensor(module):torch_tensor(type)]] when it goes out of scope. If
100100
the tensor was declared in a program then the finalizer won't get called, but
101101
this is not considered to be an issue, in the same way that in Fortran it
102102
doesn't matter if allocated arrays aren't deallocated at the end of the program.

pages/usage/troubleshooting.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -134,9 +134,9 @@ get compiler warnings of the form:
134134
Warning: The structure constructor at (1) has been finalized. This feature was removed by f08/0011. Use -std=f2018 or -std=gnu to eliminate the finalization.
135135
```
136136
These warn that the structure finalizer of the
137-
[[ftorch(module):torch_tensor(type)]] derived type is triggered when a tensor
137+
[[ftorch_tensor(module):torch_tensor(type)]] derived type is triggered when a tensor
138138
goes out of scope, despite the fact that this feature was removed from the 2008
139-
standard. That is, the [[ftorch(module):torch_tensor_delete(subroutine)]]
139+
standard. That is, the [[ftorch_tensor(module):torch_tensor_delete(subroutine)]]
140140
subroutine is called so that the associated memory is automatically freed.
141141
Firstly, this is the behaviour that we want so we should not be too concerned.
142142
Secondly, structure finalizers are not used anywhere in FTorch, so we believe
@@ -158,8 +158,8 @@ raised.
158158
@warning
159159
The code snippet above is **not** the intended way to create a tensor. The
160160
intended way is to use the provided API procedures such as
161-
[[ftorch(module):torch_tensor_from_array(interface)]] or
162-
[[ftorch(module):torch_tensor_ones(subroutine)]]. The code snippet above is
161+
[[ftorch_tensor(module):torch_tensor_from_array(interface)]] or
162+
[[ftorch_tensor(module):torch_tensor_ones(subroutine)]]. The code snippet above is
163163
only intended to illustrate the use of the structure constructor and the
164164
associated warning.
165165
@endwarning

requirements-dev.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
clang-format==19.1.3
22
clang-tidy==19.1.0
33
cmakelang
4-
ford
4+
ford>=7.0.13
55
fortitude-lint==0.7.0
66
fypp==3.2
77
ruff==0.7.3

0 commit comments

Comments
 (0)