fix: Fix URL Checker #3393

Agnik7 · 2023-10-02T12:08:51Z

Description

Fixed the broken glob pattern link in CONTRIBUTING.md. I have replaced the previous link with the following link
Fixes #3386

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

New feature (non-breaking change which adds functionality)
Optimization (back-end change that speeds up the code)
Bug fix (non-breaking change which fixes an issue)

Key checklist:

No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
All tests pass: $ python run-tests.py --all (or $ nox -s tests)
The documentation builds: $ python run-tests.py --doctest (or $ nox -s doctests)

You can run integration tests, unit tests, and doctests together at once, using $ python run-tests.py --quick (or $ nox -s quick).

Further checks:

Code is commented, particularly in hard-to-understand areas
Tests added that prove fix is effective or that feature works

Agnik7 · 2023-10-02T12:24:35Z

@Saransh-cpp I have created the PR. Requesting for your review.

agriyakhetarpal · 2023-10-02T12:26:28Z

Thanks, @Agnik7! We can skip adding this in the CHANGELOG.

Agnik7 · 2023-10-02T12:31:49Z

Ok, I'm removing it from the CHANGELOG

Agnik7 · 2023-10-02T12:33:03Z

@agriyakhetarpal I have removed it. Please check.

Agnik7 · 2023-10-02T12:41:36Z

A request to the maintainers of this repository: I am participating in Hacktoberfest, so if you merge this PR, kindly add the hacktoberfest and hacktoberfest-accepted label to it. Apologies for any inconvenience caused.

kratman · 2023-10-02T13:35:25Z

CONTRIBUTING.md

@@ -185,7 +185,7 @@ You may also test multiple notebooks this way. Passing the path to a folder will
 nox -s examples -- docs/source/examples/notebooks/models/
 ```

-You may also use an appropriate [glob pattern](https://www.malikbrowne.com/blog/a-beginners-guide-glob-patterns) to run all notebooks matching a particular folder or name pattern.
+You may also use an appropriate [glob pattern](https://developers.tetrascience.com/docs/common-glob-pattern) to run all notebooks matching a particular folder or name pattern.


This seems like a link to another software package. Is there something more general that could be used? Like Linux documentation or python documentation?

@kratman I have changed the link to a Linux documentation link. Is it alright? Please check

arjxn-py

Thanks @Agnik7, I can see that the linkChecker is still failing.
Can you please look into it? Maybe we can try with official python documentation

Agnik7 · 2023-10-02T14:58:39Z

@arjxn-py Alright changing that right now.

Agnik7 · 2023-10-02T15:00:23Z

@arjxn-py I have changed the link. Please check.

codecov · 2023-10-02T15:40:55Z

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (d02a78b) 99.58% compared to head (bc909c3) 99.58%.
Report is 30 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #3393   +/-   ##
========================================
  Coverage    99.58%   99.58%           
========================================
  Files          256      256           
  Lines        19998    19998           
========================================
  Hits         19915    19915           
  Misses          83       83

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

arjxn-py

Thanks 🙂, looks good to me.

brosaplanella

Looks good to me, thanks!

brosaplanella · 2023-10-03T12:38:55Z

@all-contributors please add @Agnik7 for documentation

allcontributors · 2023-10-03T12:39:04Z

@brosaplanella

I've put up a pull request to add @Agnik7! 🎉

brosaplanella · 2023-10-03T13:47:45Z

@Agnik7, going forward it is better to create a new branch in your fork rather than work on the develop branch, as this can cause issues.

Agnik7 · 2023-10-03T14:01:43Z

@brosaplanella alright! I'll surely keep that in mind

brosaplanella · 2023-10-03T15:19:23Z

Happy to merge once @kratman has checked the new changes :)

Agnik7 · 2023-10-03T15:21:51Z

Thanks a lot @brosaplanella for your guidance!!! Requesting @kratman to review this PR. Apologies for any inconvenience caused

kratman

Sorry, did not realize you guys were waiting on me.

This is one of the links I found when I was reviewing this initially and I think it is a reasonable one. The only other link I saw that seemed reputable was from a unix man pages project (man7.org), but python documentation is probably better for now.

Agnik7 · 2023-10-04T13:22:35Z

Thanks a lot @brosaplanella and @kratman for your invaluable suggestions and guidance throughout!! Requesting @brosaplanella a follow up to this PR. Thanks a lot!!!

kratman · 2023-10-04T13:31:11Z

@Agnik7 The change is approved, but the tests need to be re-triggered because your branch was updated. The tests take a few hours and will have to get approved before they start.

Agnik7 · 2023-10-04T13:39:35Z

@kratman Ok got it. Thanks a lot for the info!!

Agnik7 · 2023-10-07T04:06:00Z

@brosaplanella I have upstreamed this PR. Kindly approve the checks. Apologies for any inconvenience caused.

Saransh-cpp

Sorry for taking too long to approve the tests. There are a couple of more failing URLs, could you please fix them in this PR itself?

https://wigging.me should be changed to https://gavinw.me in README.md and here -

PyBaMM/.all-contributorsrc

Line 445 in d02a78b

"profile": "https://wigging.me",

The hackerearth blog post should be replaced with any alternative blog post discussing Python for R users.

Agnik7 · 2023-10-08T12:18:28Z

@Saransh-cpp alright, I'm on it!!

Agnik7 · 2023-10-08T12:39:28Z

@Saransh-cpp I have made the changes. Please have a look at them.

Saransh-cpp

Looks good, thanks, @Agnik7!

Agnik7 added 2 commits October 2, 2023 17:30

fix: Broken link

8747dd9

Update CHANGELOG.md

cbec0e9

Agnik7 mentioned this pull request Oct 2, 2023

Fix the URL checker #3386

Closed

Update CHANGELOG.md

3ebb05f

kratman reviewed Oct 2, 2023

View reviewed changes

Update CONTRIBUTING.md

278bdf4

arjxn-py reviewed Oct 2, 2023

View reviewed changes

Update CONTRIBUTING.md

cf4ead6

arjxn-py approved these changes Oct 2, 2023

View reviewed changes

Agnik7 requested a review from kratman October 2, 2023 17:09

brosaplanella approved these changes Oct 3, 2023

View reviewed changes

allcontributors bot mentioned this pull request Oct 3, 2023

docs: add Agnik7 as a contributor for doc #3399

Merged

Merge branch 'pybamm-team:develop' into develop

956f4eb

kratman approved these changes Oct 3, 2023

View reviewed changes

Merge branch 'pybamm-team:develop' into develop

c4faa5c

Agnik7 added 2 commits October 5, 2023 20:25

Merge branch 'pybamm-team:develop' into develop

df9a36e

Merge branch 'pybamm-team:develop' into develop

211f349

Saransh-cpp requested changes Oct 8, 2023

View reviewed changes

Agnik7 added 3 commits October 8, 2023 17:51

Fix URL

96eef72

Update .all-contributorsrc

f5ddab3

Update CONTRIBUTING.md

bc909c3

Saransh-cpp approved these changes Oct 8, 2023

View reviewed changes

Saransh-cpp merged commit 535c034 into pybamm-team:develop Oct 8, 2023
33 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Fix URL Checker #3393

fix: Fix URL Checker #3393

Agnik7 commented Oct 2, 2023 •

edited

Loading

Agnik7 commented Oct 2, 2023

agriyakhetarpal commented Oct 2, 2023

Agnik7 commented Oct 2, 2023

Agnik7 commented Oct 2, 2023

Agnik7 commented Oct 2, 2023

kratman Oct 2, 2023

Agnik7 Oct 2, 2023

arjxn-py left a comment •

edited

Loading

Agnik7 commented Oct 2, 2023

Agnik7 commented Oct 2, 2023

codecov bot commented Oct 2, 2023 •

edited

Loading

arjxn-py left a comment

brosaplanella left a comment

brosaplanella commented Oct 3, 2023

allcontributors bot commented Oct 3, 2023

brosaplanella commented Oct 3, 2023

Agnik7 commented Oct 3, 2023

brosaplanella commented Oct 3, 2023

Agnik7 commented Oct 3, 2023

kratman left a comment

Agnik7 commented Oct 4, 2023

kratman commented Oct 4, 2023

Agnik7 commented Oct 4, 2023

Agnik7 commented Oct 7, 2023

Saransh-cpp left a comment

Agnik7 commented Oct 8, 2023

Agnik7 commented Oct 8, 2023

Saransh-cpp left a comment

fix: Fix URL Checker #3393

fix: Fix URL Checker #3393

Conversation

Agnik7 commented Oct 2, 2023 • edited Loading

Description

Type of change

Key checklist:

Further checks:

Agnik7 commented Oct 2, 2023

agriyakhetarpal commented Oct 2, 2023

Agnik7 commented Oct 2, 2023

Agnik7 commented Oct 2, 2023

Agnik7 commented Oct 2, 2023

kratman Oct 2, 2023

Choose a reason for hiding this comment

Agnik7 Oct 2, 2023

Choose a reason for hiding this comment

arjxn-py left a comment • edited Loading

Choose a reason for hiding this comment

Agnik7 commented Oct 2, 2023

Agnik7 commented Oct 2, 2023

codecov bot commented Oct 2, 2023 • edited Loading

Codecov Report

arjxn-py left a comment

Choose a reason for hiding this comment

brosaplanella left a comment

Choose a reason for hiding this comment

brosaplanella commented Oct 3, 2023

allcontributors bot commented Oct 3, 2023

brosaplanella commented Oct 3, 2023

Agnik7 commented Oct 3, 2023

brosaplanella commented Oct 3, 2023

Agnik7 commented Oct 3, 2023

kratman left a comment

Choose a reason for hiding this comment

Agnik7 commented Oct 4, 2023

kratman commented Oct 4, 2023

Agnik7 commented Oct 4, 2023

Agnik7 commented Oct 7, 2023

Saransh-cpp left a comment

Choose a reason for hiding this comment

Agnik7 commented Oct 8, 2023

Agnik7 commented Oct 8, 2023

Saransh-cpp left a comment

Choose a reason for hiding this comment

Agnik7 commented Oct 2, 2023 •

edited

Loading

arjxn-py left a comment •

edited

Loading

codecov bot commented Oct 2, 2023 •

edited

Loading