Skip to content

Commit b3423a6

Browse files
ygucluEmilyBourne
andauthored
Link and mention devel branch, not master (pyccel#1863)
Replace `master` with `devel`, and remove references to the old `tutorials` folder: - Update link to LICENSE in the header of every file - Update links in bot welcome message - Update links and text in documentation files - Update link in module docstring of pyccel/ast/omp.py - Update links in error messages --------- Co-authored-by: EmilyBourne <[email protected]>
1 parent a644807 commit b3423a6

File tree

103 files changed

+155
-154
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

103 files changed

+155
-154
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ All notable changes to this project will be documented in this file.
4040
- #1821 : Ensure an error is raised when creating an ambiguous interface.
4141
- #1842 : Fix homogeneous tuples incorrectly identified as inhomogeneous.
4242
- #1853 : Fix translation of a file whose name conflicts with Fortran keywords.
43+
- Link and mention `devel` branch, not `master`.
4344

4445
### Changed
4546

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Hello! Welcome to Pyccel! Thank you very much for your contribution :heart:.
22

3-
I am the GitHub bot. I will help guide you through the different stages necessary to validate a review in Pyccel. If you haven't yet seen our developer docs make sure you check them out [here](https://github.com/pyccel/pyccel/tree/master/developer_docs). Amongst other things they describe the [review process](https://github.com/pyccel/pyccel/blob/master/developer_docs/review_process.md) that we have just started. You can also get in touch with our other developers on our [Pyccel Discord Server](https://discord.gg/2Q6hwjfFVb).
3+
I am the GitHub bot. I will help guide you through the different stages necessary to validate a review in Pyccel. If you haven't yet seen our developer docs make sure you check them out [here](https://github.com/pyccel/pyccel/tree/devel/developer_docs). Amongst other things they describe the [review process](https://github.com/pyccel/pyccel/blob/devel/developer_docs/review_process.md) that we have just started. You can also get in touch with our other developers on our [Pyccel Discord Server](https://discord.gg/2Q6hwjfFVb).
44

55
To begin with I will give you a short checklist to make sure your pull request is complete. Please tick items off when you have completed them or determined that they are not necessary for this pull request. If you want me to run any specific tests to check out corner cases that you can't easily check on your computer, you can request this using the command `/bot run X`. Use the command `/bot show tests` to see a full list of the tests I can run. Once you have finished preparing your pull request and are ready to request reviews just take your PR out of draft, or let me know with the command `/bot mark as ready`. I will then run the full suite of tests to check that everything is as neat as you think before asking other contributors for reviews. Tests will not run automatically before this point to avoid wasting resources. You can get a full list of commands that I understand using `/bot commands`.
66

7-
Please begin by requesting your checklist using the command `/bot checklist`
7+
Please begin by requesting your checklist using the command `/bot checklist`.

developer_docs/how_to_solve_an_issue.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@ To add a new function:
1515
## Language Specific Bug Fixes
1616

1717
- Use the issue description to reproduce the bug
18-
- Add a test targeting this specific problem (which fails in the master branch but will pass after your fix)
18+
- Add a test targeting this specific problem (which fails in the `devel` branch but will pass after your fix)
1919
- By comparing the original Python code and the generated code, try to locate the problematic line and therefore the print function in the corresponding code generation file
2020
- Try to fix the problem

developer_docs/review_process.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Review Process
22

3-
The review process is the process through which a branch which solves an issue is merged into the master branch.
3+
The review process is the process through which a branch which solves an issue is merged into the `devel` branch.
44

5-
When you believe your branch is ready to merge you should create a pull request. Be sure to add a description which allows other developers to understand what your changes aim to do. You may also want to include a commit summary as the pull request description forms the basis of the commit message shown on the master branch. In addition you should make sure that your pull request links to the issue that it is solving so that issue is automatically closed when the pull request is merged.
5+
When you believe your branch is ready to merge you should create a pull request. Be sure to add a description which allows other developers to understand what your changes aim to do. You may also want to include a commit summary as the pull request description forms the basis of the commit message shown on the `devel` branch. In addition you should make sure that your pull request links to the issue that it is solving so that issue is automatically closed when the pull request is merged.
66

77
Once the pull request is opened 9 tests should be triggered they are:
88

@@ -52,4 +52,4 @@ Once the senior developer is happy with the branch they should accept the pull r
5252

5353
Once the code has been accepted by both a junior and a senior developer it should be ready to merge. This flag therefore indicates that one of our developers with merge permissions can review the code. They will look for anything missed by the previous two reviews.
5454

55-
Anyone can make silly mistakes so Pyccel aims to have all pull requests be reviewed by at least 2 developers before being merged to master.
55+
Anyone can make silly mistakes so Pyccel aims to have all pull requests be reviewed by at least 2 developers before being merged to `devel`.

docs/CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,14 @@ Please open a pull request to add or change anything in the docs.
3838

3939
## Reviewing a pull request
4040

41-
There are many pull requests and reviewing them is a great way to help things get to the master branch faster.
41+
There are many pull requests and reviewing them is a great way to help things get to the `devel` branch faster.
4242
This is also a really good way to get to grips with the code base as you will see examples of many different areas of the code.
4343
It's incredibly helpful to have pull requests go through as many reviews as possible, to make sure the code change makes sense, is documented, and is efficient and clear.
4444
As the clarity is subjective, more eyes can only improve the code base.
45-
The review process is described in the [developer docs](https://github.com/pyccel/pyccel/blob/master/developer_docs/review_process.md), keep an eye out for pull requests tagged `needs_initial_review`.
45+
The review process is described in the [developer docs](https://github.com/pyccel/pyccel/blob/devel/developer_docs/review_process.md), keep an eye out for pull requests tagged `needs_initial_review`.
4646

4747
## Contributing code
4848

49-
Before contributing we strongly recommend you check out the [developer docs](https://github.com/pyccel/pyccel/tree/master/developer_docs).
49+
Before contributing we strongly recommend you check out the [developer docs](https://github.com/pyccel/pyccel/tree/devel/developer_docs).
5050
We try to flag `good-first-issue`s.
51-
These are either issues which can be fixed by following the example provided by a similar solution which is already implemented, or issues which only concern one of the Pyccel [stages](https://github.com/pyccel/pyccel/blob/master/developer_docs/overview.md).
51+
These are either issues which can be fixed by following the example provided by a similar solution which is already implemented, or issues which only concern one of the Pyccel [stages](https://github.com/pyccel/pyccel/blob/devel/developer_docs/overview.md).

docs/function-pointers-as-arguments.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Function-pointers as arguments
22

3-
Note: before reading this you should have read [Installation and Command Line Usage](https://github.com/pyccel/pyccel/blob/master/tutorial/quickstart.md#installation)
3+
Note: before reading this you should have read [Installation and Command Line Usage](https://github.com/pyccel/pyccel/blob/devel/docs/quickstart.md#installation)
44

55
In order to support passing [function-pointers](https://en.wikipedia.org/wiki/Function_pointer) as arguments, Pyccel needs the user to define the type of the passed function-pointers. This can be done by using the syntax `def function_name(func1_name : '(func1_return_type)(func1_arguments_types)', func2_name : '(func2_return_type)(func2_arguments_types)', ..., arg1, arg2, ...)` or using a function-header `#$ header function function_name((func1_return_type)(func1_arguments), (func2_return_type)(func2_arguments), ..., var1_type, var2_type, ...)`. Here is how Pyccel converts that feature:
66

@@ -425,7 +425,7 @@ end program prog_prog_boo
425425

426426
If you face problems with Pyccel, please take the following steps:
427427

428-
1. Consult our documentation in the tutorial directory;
428+
1. Consult our documentation in the [`docs/`](https://github.com/pyccel/pyccel/blob/devel/docs) directory;
429429
2. Send an email message to [email protected];
430430
3. Open an issue on GitHub.
431431

docs/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ Most of the unit tests can also be run in parallel.
242242

243243
To test your Pyccel installation please run the script `tests/run\_tests\_py3.sh` (Unix), or `tests/run\_tests.bat` (Windows).
244244
245-
Continuous testing runs on GitHub actions: <https://github.com/pyccel/pyccel/actions?query=branch%3Amaster>
245+
Continuous testing runs on GitHub actions: <https://github.com/pyccel/pyccel/actions?query=branch%3Adevel>
246246

247247
## Pyccel Container Images
248248

docs/quickstart.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -124,8 +124,8 @@ Such type annotations are compatible with mypy and as such are recommended for u
124124
### Installation
125125

126126
Pyccel's official releases can be downloaded from PyPI (the Python Package Index) using `pip`.
127-
To get the latest (trunk) version of Pyccel, one can clone the `git` repository from GitHub and checkout the `master` branch.
128-
Detailed installation instructions are found in the [README](https://github.com/pyccel/pyccel/blob/master/README.rst) file.
127+
To get the latest (trunk) version of Pyccel, one can clone the `git` repository from GitHub and checkout the `devel` branch.
128+
Detailed installation instructions are found in the [README](https://github.com/pyccel/pyccel/blob/devel/README.md) file.
129129

130130
### Command Line Usage
131131

@@ -484,7 +484,7 @@ Then finally, it imports this function and returns it to the caller.
484484

485485
## Other Features
486486

487-
Pyccel's generated code can use parallel multi-threading through [OpenMP](https://en.wikipedia.org/wiki/OpenMP); please read [our documentation](https://github.com/pyccel/pyccel/blob/master/tutorial/openmp.md) for more details.
487+
Pyccel's generated code can use parallel multi-threading through [OpenMP](https://en.wikipedia.org/wiki/OpenMP); please read [our documentation](https://github.com/pyccel/pyccel/blob/devel/docs/openmp.md) for more details.
488488

489489
We are also working on supporting [MPI](https://en.wikipedia.org/wiki/Open_MPI), [LAPACK](https://en.wikipedia.org/wiki/LAPACK)/[BLAS](https://en.wikipedia.org/wiki/Basic_Linear_Algebra_Subprograms), and [OpenACC](https://en.wikipedia.org/wiki/OpenACC).
490490

@@ -499,7 +499,7 @@ This tool removes all folders whose name begins with `__pyccel__` or `__epyccel_
499499

500500
If you face problems with Pyccel, please take the following steps:
501501

502-
1. Consult our documentation in the tutorial directory;
502+
1. Consult our documentation in the [`docs/`](https://github.com/pyccel/pyccel/blob/devel/docs) directory;
503503
2. Send an email message to [email protected];
504504
3. Open an issue on GitHub.
505505

pyccel/ast/basic.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#------------------------------------------------------------------------------------------#
22
# This file is part of Pyccel which is released under MIT License. See the LICENSE file or #
3-
# go to https://github.com/pyccel/pyccel/blob/master/LICENSE for full license details. #
3+
# go to https://github.com/pyccel/pyccel/blob/devel/LICENSE for full license details. #
44
#------------------------------------------------------------------------------------------#
55

66
"""

pyccel/ast/bind_c.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# -*- coding: utf-8 -*-
22
#------------------------------------------------------------------------------------------#
33
# This file is part of Pyccel which is released under MIT License. See the LICENSE file or #
4-
# go to https://github.com/pyccel/pyccel/blob/master/LICENSE for full license details. #
4+
# go to https://github.com/pyccel/pyccel/blob/devel/LICENSE for full license details. #
55
#------------------------------------------------------------------------------------------#
66
"""
77
Module describing all elements of the AST needed to represent elements which appear in a Fortran-C binding

0 commit comments

Comments
 (0)