question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Try cleaning up the CONTRIBUTING.md/developer_notes.rst dichotomy

See original GitHub issue

https://github.com/pyvista/pyvista/pull/2104 made me realise that we have two files with almost the same contents: CONTRIBUTING.md and doc/extras/developer_notes.rst.

It seems to me that the two files should have the same contents (other than the obvious markup differences), but they have diverged a bit over time. Now care must be taken to change anything in them in unison, otherwise the distance increases between the two.

So my question is: can we do something about this? Is there some way that we can generate either file from the other? Something like pypandoc perhaps, if our existing tooling can’t do this? It seems like needless repetition and maintenance overhead that would be great to get rid of. Since CONTRIBUTING.md is a standard file, the ideal direction would be to generate doc/extras/developer_notes.rst from the former. From a quick glance it seems that all links are either completely external (i.e. fully qualified URLs) or internal to the same file. This should make this more feasible.

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Reactions:2
  • Comments:5 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
tkoyama010commented, Jan 30, 2022

@adeak Thank you for pointing out this. I thought the same thing and made https://github.com/pyvista/pyvista/pull/2110.

1reaction
banesullivancommented, Jan 29, 2022

We could change CONTRIBUTING.md to be re-structured text (.rst) and then include its contents in doc/extras/developer_notes.rst when building the docs.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Clean Up! | Rodents - CDC
If you have mice or rats in or around your home or vehicle, it is important to clean up all urine, droppings, dead...
Read more >
Cleaning up after a flood | UMN Extension
Scrub walls and floors and then disinfect with bleach solution. Dry thoroughly before rebuilding. Cleaning up from a flood can seem like a...
Read more >
Cleaning Up Sources of Lead in the Home - MN Dept. of Health
The water will help hold the lead dust. Only use the wet/dry vacuum to vacuum up the wash or rinse water when you...
Read more >
Community Cleanup - Office of Justice Programs
As explained in this Bulletin, a community cleanup is a project in which volunteers of all ages work together—mowing grass, picking up trash,...
Read more >
Cleaning up after a flood - Rhode Island Department of Health
To avoid mold growth, dry out any flooded areas within 48 hours. If you have had flooding, you need to clean and dry...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found