dennisl, to accessibility
@dennisl@mastodon.social avatar

Wanted: Web Document/PDF Accessibility specialist - REMOTE [US?] https://www.linkedin.com/jobs/view/3780561524 Make sure your résumé doc is accessible!

gregorni, to random
@gregorni@fosstodon.org avatar

Gotta love it when the Gtk docs tell you a function takes a "NULL-terminated array of char*" as a parameter. 😂

(For those who don't know, this is C jargon for "a string")

#C

tvbeek, to random
@tvbeek@phpc.social avatar

Interested video and blog post from Aaron Francis about why you should the (and not skim them).

https://www.youtube.com/watch?v=hDJ5vXRPZCE

https://aaronfrancis.com/2023/read-the-docs-like-a-book

filiph, to Flutter
@filiph@mastodon.social avatar

Lots of my open source work just went live at once:

I especially enjoyed making these little accompanying illustrations.

madargon, to Software
@madargon@is-a.cat avatar

I "love" this...
In work I sometimes look for some online about some , possible service to hosting on-premise or something similar. I naively believe its authors website would be the best source.

What I expect: technical info how it's created and how it works.

What I see: "We improved ways to do [insert something I want to achieve] in most efficient ways! Many companies trusted us! Check our X, Y, Z product for A, B, C problem! [sponsors' logos in bottom part of site]"

:blobcatdisturbed:​ :blobcatdizzy:​

Krysalia, to internet French
@Krysalia@mastodon.social avatar

HAHAHAHAHAHAHA

oh, not a joke 😳 ?

et donc ouais, quand on veut stocker ses infos de profil facebook dans un truc comme google doc, le transfert refuse de fonctionner si on n'autorise "que les fichiers qui viennent de facebook". Il faut EN PLUS cocher la case obligatoire "TOUS les fichiers google docs" que Meta a ainsi le droit de modifier, éditer, supprimer etc.

BAH VOYONS --' .

jaapio, to php Dutch
@jaapio@phpc.social avatar

What if your class api docs, generated by @phpdoc would be available via an api?

I'm trying to find a way to create inter project references, that allow your api to consume the docs of your dependencies.

For example, if you base a project on classes from your framework, extend the base classes, implement interfaces. I think it would be nice to have that in your docs. With links to the original source.

What do you think?

absamma, to python
@absamma@toolsforthought.rocks avatar

Good docs always make me smile. Translating terms across knowledge domains is essential so people can map what they already know onto your API.

hugovk, to python
@hugovk@mastodon.social avatar

It's the annual Python core developer sprint, this year kindly hosted by @encukou and Red Hat in Brno, Czechia -- thank you!

The first of (at least!) three PEPs being authored this week is by @freakboy3742 and targeting Python 3.13:

PEP 730 – Adding iOS as a supported platform

https://peps.python.org/pep-0730/

Discussions:

https://discuss.python.org/t/pep-730-adding-ios-as-a-supported-platform/35854?u=hugovk

hugovk,
@hugovk@mastodon.social avatar

Two more PEPs have been published that we worked on at the CPython core dev sprint.

PEP 732 – The Python Documentation Editorial Board

https://peps.python.org/pep-0732/

https://discuss.python.org/t/pep-732-the-python-documentation-editorial-board/36710?u=hugovk

PEP 733 – An Evaluation of Python’s Public C API

https://peps.python.org/pep-0733/

https://discuss.python.org/t/pep-733-an-evaluation-of-python-s-public-c-api/37618?u=hugovk

And listen to @ambv and Pablo Galindo Salgado's brand new podcast, the first episode was about the sprint:

https://mastodon.social/@ambv/111261671844167053

chipx86, (edited ) to python
@chipx86@mastodon.online avatar

ReStructuredText writers, where do you like to put your

.. _RefName: <target>

definitions?

While we're at it, what are your personal ReST best practices? Share in the comments!

hugovk, to python
@hugovk@mastodon.social avatar

🆕 When you visit https://docs.python.org you can now hit the forward slash key ➡️ / ⬅️ to highlight the search box, and immediately start typing your query. Try it!

💡 You can use the same shortcut on many other sites, such as PyPI, GitHub, YouTube, Discourse (https://discuss.python.org) and Furo-themed docs (https://devguide.python.org).

Happy searching! ⌨️🔎📚

hankuoffroad, to linux
@hankuoffroad@floss.social avatar

The Fedora Docs team have done the first onboarding session. If you missed it, you still have a chance to drop into a Jitsi meeting on 18:00 UTC later. Peter and I will greet you. See you then.

Jitsi meeting link is here:
https://meet.jit.si/fedoradocsworkshop

hankuoffroad, to fedora
@hankuoffroad@floss.social avatar

Come along to the writing workshop hosted by the Fedora Docs team on Thursday 28 September 12:00 → 12:30 and 18:00 → 18:30 (UTC). Choose one that suits your timezone.

No registration is necessary. Just write your name or nick on Jitsi Meet UI before you click 'join meeting'.

Agenda:

  • Intro to Docs team
  • Systems and accesses
  • How can you have a part in Fedora Docs?
  • Docs glossary
  • Ask anything

Jitsi meeting link is here:
https://meet.jit.si/fedoradocsworkshop

Sphinx_Pouet, (edited ) to webdev French
@Sphinx_Pouet@mamot.fr avatar

Coucou tout le monde, je vais me lancer dans la traduction de https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Tutorials/CycleTracker (merci @estelle 🙇‍♂️) en français : si ça vous intéresse d'y participer n'hésitez pas à faire signe ! :)

Vous pouvez commenter sur https://github.com/mdn/translated-content/issues/16137

onrust, to TechnicalWriting

All talks from last week’s conference are now ready to watch online ✨

There’s some super good material here for anyone interested in documentation and tech writing, including:

  • OpenTelemetry explained in a graphic novel, by @remoquete
  • Sensitive info you might leak via your documentation, by @SpliceFixer
  • OpenAPI for the brave and true, by @lornajane

… oh and yours truly did a talk on AI ethics for tech writers: https://www.youtube.com/watch?v=SDzP6Xs9WoQ

Here’s the full playlist: https://www.youtube.com/watch?v=96V202-7Ovk&list=PLZAeFn6dfHplddJfvbke1bpUzZGozb2Yj

gregorni, to random
@gregorni@fosstodon.org avatar

Man I didn't even notice now has a dedicated page for its . So much better than the old READMEs on GitHub style! https://docs.flathub.org/

daria, to python

Folks, if you could suggest improvements to the documentation, what would it be? Improved ToC? More examples? Different structure?

hugovk,
@hugovk@mastodon.social avatar

@plaimbock @daria

Good news! These already exist!

At the top left of https://docs.python.org/3/ is "Download these documents" taking you to https://docs.python.org/3/download.html

There's a zip of PDFs of each section, including one for the tutorial, and an epub of the whole thing.

plaimbock,
@plaimbock@fosstodon.org avatar

@hugovk @daria Thanks Hugo! I totally missed that link yesterday so please excuse the PEBKAC 😋️

historyofpunkrock, to punk
@historyofpunkrock@sfba.social avatar

'Always wear shoes that are good for running or fighting.' — Joe Strummer

hugovk, to python
@hugovk@mastodon.social avatar
daria, to python

Anyone else feeling like could use a revamp? 🐍

cazabon, to internet

Google's "Web Environment " is one of the things I have ever seen proposed for the , possibly only behind being required for any access.

https://github.com/RupertBenWiser/Web-Environment-Integrity/blob/main/explainer.md

Let's get this out of the way: they give a number of why "might wish" to establish that a web is running on a "" software stack, including things like "make sure other game players aren't cheating" and "ensure I'm talking to another human".

1/x

cazabon,

has . And Google . And Google . And Google . And . And about a thousand other sites and services.

If not using a Google-endorsed means to all of that, most people are not going to be able to make that choice. They're going to have to use , and they'll have to put up with it shoving " ads" (aka all-encompassing in the middle of your attempt to use the service) and a million other ads.

10/x

yugaego, to orgmode

A point not to miss in

Org provides methods to create a link in the correct syntax, to insert it into an Org file, and to follow the link.

The main function is 'org-store-link', called with 'M-x org-store-link'. ... It stores a link to the current location.  

I didn't realize such stored links then suggested for completion on 'M-x org-insert-link ('C-c C-l).

A Tip! Try 'org-store-link' with

(setq org-id-link-to-org-use-id 'use-existing)

Stark9837, to python
@Stark9837@techhub.social avatar

Python import: Advanced Techniques and Tips

I thought I knew until I read this. The plugins' functionality was quite interesting, and I have a few ideas about what I can use it for. One thing I miss in Python that I often use is in are true abstract classes, overloading, and extension of classes. With tools like this, you can achieve similar functionality.

https://realpython.com/python-import/#example-use-data-files

Stark9837,
@Stark9837@techhub.social avatar

Normally, after reading an article like this, I like to go back to the official documentation. Articles like this teach by example and plant seeds, terms, words, and concepts in your brain. Going back to the documentation, you then get a better understanding of what you read. It also gives more meankng and some sense to the chaos that documentation can often introduce.

https://docs.python.org/3/reference/import.html

hugovk, to python
@hugovk@mastodon.social avatar
hugovk,
@hugovk@mastodon.social avatar
  • All
  • Subscribed
  • Moderated
  • Favorites
  • JUstTest
  • GTA5RPClips
  • DreamBathrooms
  • InstantRegret
  • magazineikmin
  • khanakhh
  • Youngstown
  • ngwrru68w68
  • slotface
  • everett
  • rosin
  • thenastyranch
  • kavyap
  • tacticalgear
  • megavids
  • cisconetworking
  • normalnudes
  • osvaldo12
  • ethstaker
  • mdbf
  • modclub
  • Durango
  • tester
  • provamag3
  • cubers
  • Leos
  • anitta
  • lostlight
  • All magazines