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.

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

Issue on page /fem.html #167

Closed
mmoelter opened this issue Dec 19, 2023 · 4 comments
Closed

Issue on page /fem.html #167

mmoelter opened this issue Dec 19, 2023 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@mmoelter
Copy link
Contributor

= 1st paragraph
-- 1st sentence:
...for solving partial differential equations.
should be
...for solving partial differential equations (PDEs).

-- 2nd sentence:
The project was initiated in 2003, and is developed in collaboration between researchers from a number of universities and research institutes around the world.
should be
The project was initiated in 2003, and is developed in a collaboration among researchers from several universities and research institutes around the world.

-- 2nd paragraph, 1st sentence:
The latest version of the FEniCS project, FEniCSx, consists of several building blocks, namely Basix, UFL, FFCx and DOLFINx.

should be (put Dolfinx first to match the order of the following text)

The latest version of the FEniCS project, FEniCSx, consists of several building blocks, DOLFINx, namely Basix, UFL, and FFCx.

= "What you will learn"
-- 1st sentence:
...to solve PDEs in FEniCS.
should be
...to solve PDEs using FEniCS.

-- sentence after bulleted list
Important topics involve how...
should be
Important topics include: how...

= "How to use this tutorial"
-- 2nd sentence:
Therefore we will mostly...
should be
Therefore, we will mostly...

= "Obtaining the software"
-- sentence after "Tutorial compatible docker images":
...is available in the Github Packages)
should be (remove parentheses, add period)
...is available in the Github Packages.

-- sentence before heading "Official images":
The tutorials can also be exported as a notebook or PDF by...
should be
The tutorials can also be exported as an IPython notebook or PDF by...

-- 2nd sentence after heading "Official images":
...one can directly access the image:
should be
...one can directly access the image using:

-- sentence before heading "Installation from source":
If all goes well, no error-messages should appear.
should be
If all goes well, no error messages should appear.

= Introduction to the finite element method
-- 1st sentence:
In the last decade, a wide range of lecture notes on finite elements methods has been made open access.
should be
In the last decade, several sets of lecture notes on finite element methods have been made open access.

-- sentence after bulleted list of materials:
There has been written many good text-books on the finite element method, and we refer to the original FEniCS tutorial, for references to these,...
should be
Many good textbooks on the finite element method have been written, and we refer to the original FEniCS tutorial for references to these,...

@jorgensd jorgensd added the documentation Improvements or additions to documentation label Dec 19, 2023
@jorgensd
Copy link
Owner

@mmoelter Thanks for the suggestions. Your changes in a pull request would be welcomed, then your suggestions will get counted as your contributions.

@mmoelter
Copy link
Contributor Author

mmoelter commented Dec 20, 2023 via email

@jorgensd
Copy link
Owner

@mmoelter Did you want to make this PR? I've seen the other PRs, but they don't seem to have these changes.

@mmoelter
Copy link
Contributor Author

I did it shortly after your suggestion and then it was merged on Dec 20 (#168).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants