Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 35 additions & 12 deletions .pyspelling.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
matrix:
- name: markdown
hunspell:
d: en_US
aspell:
lang: en
d: en_US
mode:
- markdown
- url
- email
ignore-case: true # I'm not sure this is doing anything.
ignore-accents: true # I'm not sure this is doing anything.
dictionary:
wordlists:
- docs/spelling_wordlist
Expand All @@ -17,6 +28,7 @@ matrix:
- pymdownx.blocks.admonition
- pymdownx.blocks.caption
- pymdownx.blocks.tab
- pymdownx.details
- pyspelling.filters.html:
comments: true
attributes:
Expand All @@ -25,24 +37,35 @@ matrix:
ignores:
- 'code'
- 'pre'
- 'div'
- 'a'
- 'nospell'
- 'script'
- pyspelling.filters.context:
context_visible_first: true
escapes: '\\[\\`~]'
# escapes: '\\[\\`~]'
delimiters:
# Ignore the Jinja directives
- open: '{%'
content: '[\d\D]*'
close: '%}'
- open: '{% '
close: ' %}'
# Ignores the autorefs link targets
- open: '\]\['
content: '[\d\D]*'
close: '\]'
# Ignore the single line Snippets syntax
- open: '-8<\-'
content: '[\d\D]*'
close: '\n'
# Ignore the multiline Snippets syntax
- open: '-8<\-\n'
content: '[\d\D]*'
close: '-8<-\n'
- open: '-8<- '
close: '$'
# Ignore the .md URLs - appears to be fixed by mode: url above
#- open: 'https?:'
# close: '\.md(:[-\w]+)?'
# Ignore urls in frontmatter - This is still necessary with mode: url
- open: 'url: '
close: '$'
# Ignore toc in frontmatter
- open: '- toc'
close: '$'
# Ignore numbers with a suffix, e.g. dates
- open: '[0-9]+'
close: '[rshndt]*'
# Ignore version numbers - TODO: verify this does what I think it does
- open: '[0-9\.]+[a-z]*'
close: '[0-9]*'
6 changes: 3 additions & 3 deletions docs/en/about/history.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ And so, we're left with an interesting schism, between the "old way" of Unix dev

### The Unix Philosophy

However, it doesn't have to be that way. The core tenet of the Unix Philosophy is that "each tool does one thing, well". This is a very powerful philosophy, and it enables the composition of extremely powerful toolchains by putting together a suite of extremely focussed, independent tools.
However, it doesn't have to be that way. The core tenet of the Unix Philosophy is that "each tool does one thing, well". This is a very powerful philosophy, and it enables the composition of extremely powerful toolchains by putting together a suite of extremely focused, independent tools.

Unfortunately, most UNIX tools have convolved this to also mean "all tools must use a console interface". However, there's nothing in the UNIX philosophy that says that tools have to use a console interface - it's just turned out that way.

Expand All @@ -30,13 +30,13 @@ Even then, it's easy to think of a project in a vacuum, as the sum of all contri

A diverse community is a strong community. This means accepting people of all levels of experience, from all backgrounds, of all races, creeds, orientations and expressions. The BeeWare project is committed to developing and maintaining a inclusive, diverse and welcoming community.

To back this up, we have an open offer to mentor anyone who wants to get involved as a contributor, and a [Code of Conduct](/community/code-of-conduct.md) that is rigorously enforced. Any reports of violations of that code of conduct - even by senior community members - will be treated with respect and actioned appropriately.
To back this up, we have an open offer to mentor anyone who wants to get involved as a contributor, and a [Code of Conduct](/community/code-of-conduct.md) that is rigorously enforced. Any reports of violations of that code of conduct - even by senior community members - will be treated with respect and acted upon appropriately.

### Healthy and sustainable

It's also important to make sure that the community is accessible and sustainable. It's unfortunately become an accepted part of Open Source culture that "true" Open Source projects have to be developed entirely by volunteers. This acts as a barrier to entry for many groups - the only people able to spend their free time volunteering are those that *have* free time.

It also frequently leads to burnout and other mental health issues amongst contributors. The fact that depression, anxiety, and burnout are so common in software development communities shouldn't be considered a badge of honour, or a demonstration of how committed a development team can be. It's a problem that needs to be tackled head on, and addressed in the same way a software bug would be addressed - with immediate workarounds, and long term plans to remove the systemic cause of the problem.
It also frequently leads to burnout and other mental health issues amongst contributors. The fact that depression, anxiety, and burnout are so common in software development communities shouldn't be considered a badge of honor, or a demonstration of how committed a development team can be. It's a problem that needs to be tackled head on, and addressed in the same way a software bug would be addressed - with immediate workarounds, and long term plans to remove the systemic cause of the problem.

While we place incredible value on the contributions of volunteers, we also know that volunteer efforts alone aren't the way to develop a healthy and sustainable community. For that reason, financial sustainability is a key consideration in the operation of the BeeWare project. As a community, we don't ignore the role that money has to play in providing the resources that allows people to begin and continue to contribute. We will, as a community, provide accepted mechanisms for individuals to monetize their work in meaningful ways, and wherever possible, compensate people for their work - without compromising the ideals of Open Source development.

Expand Down
2 changes: 1 addition & 1 deletion docs/en/about/team/cflee.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Chiang Fong has been pretending to be a systems administrator since the Mandriva Linux days, and has recently moved into acting like he knows how to write software.
<nospell>Chiang Fong</nospell> has been pretending to be a systems administrator since the <nospell>Mandriva</nospell> Linux days, and has recently moved into acting like he knows how to write software.

When not poking at code to de-stress, he spends his time fiddling with fountain pens and mechanical keyboards. He has yet to learn the lesson of not mixing inky fingers with pretty keycaps.
2 changes: 1 addition & 1 deletion docs/en/about/team/flowerncsu.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Charlotte has been coding for more years than she likes to admit, and has a passion for building cool things and helping other people learn how to build cool things. She is among the organizers of PyLadies RDU, and can often be found making things out of yarn when not making things out of code.
Charlotte has been coding for more years than she likes to admit, and has a passion for building cool things and helping other people learn how to build cool things. She is among the organizers of PyLadies <nospell>RDU</nospell>, and can often be found making things out of yarn when not making things out of code.
2 changes: 1 addition & 1 deletion docs/en/about/team/obulat.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Olga is a python and BeeWare enthusiast, also interested in NLP, geography and languages.
Olga is a python and BeeWare enthusiast, also interested in <nospell>NLP</nospell>, geography and languages.

She also enjoys hanging out with kids.
2 changes: 1 addition & 1 deletion docs/en/about/team/phildini.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Philip writes code for computers and for humans. His first computing love is Python, but is too often forced to write JavaScript and Swift. When he's not writing code for money or for Open Source or for his own crazy projects, he gives talks at conferences. Philip lives in Alameda, California with his wife and her cat. Philip believes in the web.
Philip writes code for computers and for humans. His first computing love is Python, but is too often forced to write JavaScript and Swift. When he's not writing code for money or for Open Source or for his own crazy projects, he gives talks at conferences. Philip lives in <nospell>Alameda</nospell>, California with his wife and her cat. Philip believes in the web.
2 changes: 1 addition & 1 deletion docs/en/about/team/samschott.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Sam is a physicist and a software engineer. He got introduced to Python while automating data acquisition in the lab and soon realised that he enjoyed writing and sharing code. When away from a computer, you will find him hiking or sailing along the English coast.
Sam is a physicist and a software engineer. He got introduced to Python while automating data acquisition in the lab and soon realized that he enjoyed writing and sharing code. When away from a computer, you will find him hiking or sailing along the English coast.
2 changes: 1 addition & 1 deletion docs/en/about/team/saroad2.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Sagi Shadur is a software engineer and a mathematician. He has a B.Sc. in mathematics and these days he's on his way for a second B.Sc. in physics. He's also a poet who published two books in Hebrew, "Mountains and Valleys" and "The Emissary".
<nospell>Sagi Shadur</nospell> is a software engineer and a mathematician. He has a B.Sc. in mathematics and these days he's on his way for a second B.Sc. in physics. He's also a poet who published two books in Hebrew, "Mountains and Valleys" and "The Emissary".
4 changes: 2 additions & 2 deletions docs/en/community/code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

--8<-
-8<-

https://raw.githubusercontent.com/beeware/.github/refs/heads/main/CODE_OF_CONDUCT.md

--8<-
-8<-
2 changes: 1 addition & 1 deletion docs/en/community/governance.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Founding Apiarist: [Russell Keith-Magee](/about/team.md#freakboy3742)
- This role is different to the BDFN role

Bee-nevolent Dictator for Now (BDFN): [Russell Keith-Magee](/about/team.md#freakboy3742)
- A take on [Benevolent Dictator for Life](https://en.wikipedia.org/wiki/Benevolent_dictator_for_life), responsibility for the direction and decisions of the project ultimately lies with the BFDN. The use of "For Now" as opposed to "For Life" is reference to the Django theme of not subjecting the responsibilities of core maintainer for a person's entire natural life. Life exists outside open source, and code/life balance and general well-being is a very important thing to keep in mind.
- A take on [Benevolent Dictator for Life](https://en.wikipedia.org/wiki/Benevolent_dictator_for_life), responsibility for the direction and decisions of the project ultimately lies with the BDFN. The use of "For Now" as opposed to "For Life" is reference to the Django theme of not subjecting the responsibilities of core maintainer for a person's entire natural life. Life exists outside open source, and code/life balance and general well-being is a very important thing to keep in mind.

## Guidelines (not actual rules)

Expand Down
4 changes: 2 additions & 2 deletions docs/en/contributing/challenge-coins.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The front and back of the BeeWare Yak Herder Coin.

///

The first run of 100 BeeWare Challenge Coins were commissioned thanks to financial support from MaxCDN. They also wrote an [article about BeeWare](https://web.archive.org/web/20170923205703/https://www.maxcdn.com/blog/beeware-be-sticky/) on their blog.
The first run of 100 BeeWare Challenge Coins were commissioned thanks to financial support from <nospell>MaxCDN</nospell>. They also wrote an [article about BeeWare](https://web.archive.org/web/20170923205703/https://www.maxcdn.com/blog/beeware-be-sticky/) on their blog.

[Revolution Systems](https://revsys.com) provided the funding for the second pressing of the BeeWare challenge coins.

Expand All @@ -38,6 +38,6 @@ The first run of 100 BeeWare Challenge Coins were commissioned thanks to financi

/// caption

One happy BeeWare coin recipient. Photo by @atomimages
One happy BeeWare coin recipient. Photo by <nospell>@atomimages</nospell>

///
4 changes: 2 additions & 2 deletions docs/en/contributing/sprint-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ To get you started, we're going to ask a few questions so we can gauge your inte

1. **Have you used BeeWare before?**

If you haven't, start by working through the [BeeWare Tutorial](https://docs.beeware.org/en/latest/). It will give you an introduction for what the BeeWare project is, and how the pieces of the project fit together. If you hit any problems doing the tutorial, take notes - because ensuring nobody else has the same problem is a great topic for a first contribution!
If you haven't, start by working through the [BeeWare Tutorial](https://tutorial.beeware.org). It will give you an introduction for what the BeeWare project is, and how the pieces of the project fit together. If you hit any problems doing the tutorial, take notes - because ensuring nobody else has the same problem is a great topic for a first contribution!

Once you've finished the tutorial up to at least step 4, move on to the next question.

Expand All @@ -34,7 +34,7 @@ To get you started, we're going to ask a few questions so we can gauge your inte

4. **Are you familiar with GitHub contribution processes?**

Do you use GitHub (or a similar code-sharing site) for hosting your own code or contributing to others' projects? Do you know what CI (continuous integration) is? Have you contributed to a project that has pre-commit hooks? If I asked you to "rebase your PR against main", would you know what to do?
Do you use GitHub (or a similar code-sharing site) for hosting your own code or contributing to others' projects? Do you know what CI (continuous integration) is? Have you contributed to a project that has pre-commit hooks? If I asked you to "`rebase` your PR against main", would you know what to do?

5. **Have you contributed to an Open Source project before?**

Expand Down
8 changes: 4 additions & 4 deletions docs/en/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,11 @@ Applications maintained by the BeeWare team that are built using BeeWare's tools

<div class="other-tools-package" markdown="1">

[![Podium](../images/podium.png)](https://podium.beeware.org){ .other-tools-logo }
[![Podium](../images/podium.png)](https://github.com/beeware/podium){ .other-tools-logo }

<div class="other-tools-info" markdown="1">

#### [Podium](https://podium.beeware.org) { .podium-name }
#### [Podium](https://github.com/beeware/podium) { .podium-name }

<div class="podium-info" markdown="1">

Expand Down Expand Up @@ -90,11 +90,11 @@ A library for bridging between Python and the Objective-C language runtimes.

<div class="other-tools-package" markdown="1">

[![Brutus the Bee](../images/brutus.png)](https://python-apple-support.beeware.org){ .other-tools-logo }
[![Brutus the Bee](../images/brutus.png)](https://github.com/beeware/python-apple-support){ .other-tools-logo }

<div class="other-tools-info" markdown="1">

#### [Python Apple Support](https://python-apple-support.beeware.org) { .python-apple-name }
#### [Python Apple Support](https://github.com/beeware/python-apple-support) { .python-apple-name }

<div class="python-apple-info" markdown="1">

Expand Down
8 changes: 7 additions & 1 deletion docs/en/membership/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ With more than 45 million users, [Anaconda](https://anaconda.com/) is the most p

### Professional Members

<nospell>
<div class="pro-members" markdown="1">
<div class="pro-member-avatar" markdown="1">![Lincoln Loop logo](images/lincolnloop.png)</div> <div class="pro-member-name">Lincoln Loop</div>
</div>
Expand All @@ -61,9 +62,11 @@ With more than 45 million users, [Anaconda](https://anaconda.com/) is the most p
<div class="pro-members" markdown="1">
<div class="pro-member-avatar" markdown="1">![Matthias Kestenholz](images/mkestenholz.png)</div> <div class="pro-member-name">Matthias Kestenholz</div>
</div>
</nospell>

### Enthusiasts

<nospell>
- Timothy Bell
- Wes Broadway
- Gerard Blais
Expand All @@ -72,9 +75,12 @@ With more than 45 million users, [Anaconda](https://anaconda.com/) is the most p
- Eric Froemling
- Michal Sladek
- Stefane Fermigier
<!-- Github Sponsors -->
</nospell>
<!-- GitHub Sponsors -->
<nospell>
- Katie McLaughlin
- Emil Lerner
- Hassan Hashmi
- Greg Turner
- David Cramer
</nospell>
14 changes: 7 additions & 7 deletions docs/en/news/posts/2013/resources/tinkering-with-tkinter.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Tinkering with Tkinter
title: Tinkering with <nospell>Tkinter</nospell>
date: 2013-07-10
authors:
- freakboy3742
Expand All @@ -13,21 +13,21 @@ resource:
event_name: PyCon AU 2013
event_url: ''
description: |-
Tkinter - the Python wrapper to the Tk graphics library - has been part
<nospell>Tkinter</nospell> - the Python wrapper to the <nospell>Tk</nospell> graphics library - has been part
of the Python standard library since very early on. However, that
inclusion hasn't translated into extensive use.

There was a very good reason for this. Tk's documentation was beyond
awful. And if you managed to get over that hurdle, Tkinter apps looked
There was a very good reason for this. <nospell>Tk's</nospell> documentation was beyond
awful. And if you managed to get over that hurdle, <nospell>Tkinter</nospell> apps looked
awful - they had a woefully inadequate set of widgets, styled with the
very best of mid 1990's open source graphic skill.

And then, the world got obsessed with web frameworks, and the desktop
was declared as dead.

However, in the last few years, many of the reasons Tkinter was ignored
have been quietly fixed. Tk 8.4 massively improved the visual appearance
of Tk. tkdocs.com has emerged, addressing many of the problems with Tk
However, in the last few years, many of the reasons <nospell>Tkinter</nospell> was ignored
have been quietly fixed. <nospell>Tk</nospell> 8.4 massively improved the visual appearance
of <nospell>Tk</nospell>. tkdocs.com has emerged, addressing many of the problems with <nospell>Tk</nospell>
documentation.

In this talk, you'll get a re-introduction to an old friend, and an
Expand Down
2 changes: 1 addition & 1 deletion docs/en/news/posts/2016/buzz/hello-website.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,6 @@ The new website uses [Lektor](https://www.getlektor.com), a static site generato

Although we're launching the site today, it's not complete. There's still content that needs to be written, and styling that needs to be fixed. However, we think that the new site is better than the old one, and therefore it's not worth delaying the launch any longer.

This also gives you - the BeeWare community - a great opportunity to contribute. If you find something that is missing from the site, or something that you think could be expressed better, or designed better, the entire site is [available on GitHub](https://github.com/beeware/beeware.github.io/tree/lektor). Fork the repository, make the change you think that is needed, and submit a pull request (against the <span class="title-ref">Lektor</span> branch - not <span class="title-ref">master</span>). All contributions are welcome, and as with all BeeWare contributions, website contributions make the submitter all eligible to receive an exclusive [BeeWare Challenge Coin](/contributing/challenge-coins.md).
This also gives you - the BeeWare community - a great opportunity to contribute. If you find something that is missing from the site, or something that you think could be expressed better, or designed better, the entire site is [available on GitHub](https://github.com/beeware/beeware.github.io/tree/lektor). Fork the repository, make the change you think that is needed, and submit a pull request (against the `Lektor` branch - not `master`). All contributions are welcome, and as with all BeeWare contributions, website contributions make the submitter all eligible to receive an exclusive [BeeWare Challenge Coin](/contributing/challenge-coins.md).

We hope you enjoy the new site; if you've got any feedback, let us know [with a ticket](https://github.com/beeware/beeware.github.io/issues/) or [on our Discord server](https://beeware.org/bee/chat/).
Loading