Do all the things like ++ or -- rants, post your own rants, comment on others' rants and build your customized dev avatarSign Up
From the creators of devRant, Pipeless lets you power real-time personalized recommendations and activity feeds using a simple APILearn More
Search - "markdown"
So, I'm stuck...
I'm very passionate about technology. Coding and development and soldering together some raspberry pi or arduino project gets me all swept up in a false sense of belonging & sense of purpose. It's just always been my biggest passion...
As well as it has simultaneously been an elusive dream, driven away by circumstances and some pretty shitty decision making on my end... But, it's always a recurring theme and source of illumination through some dark moments... Abandonment of my dreams isn't an option.... I spent 10+ years on heroin and somehow still have the ability to dredge up some hope, surely I can finally get my foot/hand/ball sack in the door of my dreams... right??
Anyways, to sum up my ability in regard to technology/coding etc.... I'm a highly motivated and passionate Beginner-intermediate level tech enthusiast with a little html, css, Java, markdown/git know how, advanced soldering/PC building ability... With a high need to remain studious and get my ass balls deep in some computuh' learnin' circles.
In all seriousness, I really would like to be graciously provided with some communities and groups of folks that would assist me upon my path, and possibly ways I could slide into some sort of tech based career/job while amassing my IT abilities.
I am willing, but incapable of starting off in the right direction & in need of some guidance to firmly trod on towards my goals...
PS: I'm totally not a 32 year old man desperately in need of some guidance and reassurance... cause that'd make me some kinda loser or something... pfffft... I won't be 32 until 06/08.... so all is well and good 👍
Thanks in advance peeps. Later!17
Markdown. It is now used by MDN Web Docs and supported by Google Docs. End users will slowly pick up. Then even more (proprietary) flavors of markdown and their accompanying JS-frameworks will follow. All with good intentions, but it can only to end in a big mess and confusion like USB or USB 3.2 Gen 1.5
I used to think that I had matured. That I should stop letting my emotions get the better of me. Turns out there's only so much one can bottle up before it snaps.
Allow me to introduce you folks to this wonderful piece of software: PaddleOCR (https://github.com/PaddlePaddle/...). At this time I'll gladly take any free OCR library that isn't Tesseract. I saw the thing, thought: "Heh. 3 lines quick start. Cool.", and the accuracy is decent. I thought it was a treasure trove that I could shill to other people. That was before I found out how shit of a package it is.
First test, I found out that logging is enabled by default. Sure, logging is good. But I was already rocking my own logger, and I wanted it to shut the fuck up about its log because it was noise to the stuffs I actually wanted to log. Could not intercept its logging events, and somehow just importing it set the global logging level from INFO to DEBUG. Maybe it's Python's quirk, who knows. Check the source code, ah, the constructors gaves `show_log` arg to control logging. The fuck? Why? Why not let the user opt into your logs? Why is the logging on by default?
But sure, it's just logging. Surely, no big deal. SURELY, it's got decent documentation that is easily searchable. Oh, oh sweet summer child, there ain't. Docs are just some loosely bundled together Markdowns chucked into /doc. Hey, docs at least. Surely, surely there's something somewhere about all the args to the OCRer constructor somewhere. NOPE! Turns out, all the args, you gotta reference its `--help` switch on the command line. And like all "good" software from academia, unless you're part of academia, it's obtuse as fuck. Fine, fuck it, back to /doc, and it took me 10 minutes of rummaging to find the correct Markdown file that describes the params. And good-fucking-luck to you trying to translate all them command line args into Python constructor params.
"But PTH, you're overreacting!". No, fuck you, I'm not. Guess whose code broke today because of a 4th number version bump. Yes, you are reading correctly: My code broke, because of a 4th number version bump, from 126.96.36.199, to 188.8.131.52, introducing a breaking change. Why? Because apparently, upstream decided to nest the OCR result in another layer. Fuck knows why. They did change the doc. Guess what they didn't do. PROVIDING, A DAMN, RELEASE NOTE. Checked their repo, checked their tags, nothing marking any releases from the 3rd number. All releases goes straight to PyPI, quietly, silently, like a moron. And bless you if you tell me "Well you should have reviewed the docs". If you do that for your project, for all of your dependencies, my condolences.
Could I just fix it? Yes. Without ranting? Yes. But for fuck sake if you're writing software for a wide audience you're kinda expected to be even more sane in your software's structure and release conventions. Not this. And note: The people writing this, aren't random people without coding expertise. But man they feel like they are.6
So I thought there might be some people here
that care about formatting and would enjoy this:
*Or people that just want to improve*
*their README / documetation I guess~*4
Companies that make things devs have to work with: please stop trying to implement your own version of markdown. I don't want to memorize 3 different ways of making links6
story of a release
v2.1.0 major changes went live : new features, bug fixes, optimisations. also included releases for 2 associated libraries
release process tasks:
- do code
- update test cases
- test sample app
- test on another sample app
- get code reviewed and approved by senior ( who takes his own sweet time to review and never approves on first try)
- get code reviewed again
- merge to develop after 20 mins( coz CICD pipeline won't finish and allow merging before that)
- merge to master after 20 mins( coz CICD again)
- realise that you forgot to update dates in markdown files as you thought the release will be on 10th sept and release is happennig on 12th sept coz of sweet senior's code fucking/reviewing time
- again raise a branch to develop
- again get it a review approval by sr (who hopefully gives a merge approval in less time now)
- again get it merged to develop after waiting for 20 mins
- again get it merged to master after waiting for 20 mins
- create a clean build aar file
- publish to sonatype staging
- publish to sonatype release
- wait for 30 mins to show while having your brain fucked with tension
- create a release doc with all the changes
- update the documentation on a wyswig based crappy docs website
- send a message to slack channels
why am i telling you this? coz i just found a bug in a code that i shipped in that release which still got in after all the above shitty processes. its a change of a 3 lines of code, but i will need to do all the steps again. even though i am going through the same shitty steps for another library version upgrade that depends on this library 😭😭
AND I AM THE ONE WHO CAUGHT IT. it went unnoticed because both of those shitty samples did not tested this case. now i can keep mum about it and release another buggy build that depends on it and let the chaos do its work, or i can get the blame and ship a rectification asap. i won't get any reward or good impression for the 2nd, and a time bomb like situation will get created if i go with 1st :/
Follow-up on https://devrant.com/rants/5001553/...
How the fuck are Jupyter notebooks so popular in research? Like some dude had an idea to take perfectly good markdown and python code, add a whole lot of transitional properties to make version control impossible, encode it as JSON on the assumption that a human could somehow look at it and make sense of countless escaped characters and base64 encoded data, create dedicated software people need to install in order to read what used to be simple plain text, and think "This. This is what 99% of data researchers will use from now on." And somehow, overwhelming majority of researchers agreed that this extremely inefficient data format is the best there is and they should develop all their tools around it.11
Asciidoc! I finally got around to play around with it and it is just so awesome! Best tool for documentation hands down! So many improvements over Markdown:
- importing real code snippets based on tags with syntax highlighting and annotations (which can be also auto numbered with "<.>" instead of "<1>"!)
- Admotions! Love them!
- automatic TOC! Finally!!
- joining a child item to a parent item in a list with "+" in a new line (this one took me a while to understand, but no more offset items in lists! Love it!)
- making tables and loading data from an actual CSV-file! The future is now!!
- embedding images with a fixed size
Just a few things from the top of my head. I don't know why I put up with vanilla Markdown all these years...
Last but not least, a big THANK YOU to everyone who recommended Asciidoc! I accidentally stumbled across multiple mentions of Asciidoc a few months ago. Sorry, but you know who you are! Much love to you and your loved ones! You changed my life for the better. Thank you!
Anybody need some help with documentation?
( GitHub Only )
Check these links for my style:
Can we have a moment of silence for the jekyll themes that are supported on GitHub?
Jesus Christ I'm in the graveyard here5
( Temporarily Relevant )
Is it just me or did GitHub just break most of their MathJax?
Were formulas but now I only see my LaTeX code..
Started documenting on how to use ＬａＴｅＸ ( MathJax ) in Ｍａｒｋｄｏｗｎ.
Let me know if you have a topic that you would like to be documented sooner than others~
Image shows an example usage
from a project I'm working on:
Finally got around to turning the news-section generator markdown / deno thingy into a GitHub Action!
Haven't finished writing the documentation though.
y'all got any markdown programm recommendations?
Someone (maybe on here) said they use MD for everything instead of word.
Now I wondered, which programm works well for that? Word or a full IDE seems kinda overkill
MS Teams markdown shortcuts are now broken for me and my whole org. Literally never happened with discord or slack. How is a company this big so bad at making good software?2
Found a 'new' little way of customizing /
stylizing / formatting GitHub markdown.
Because of that I just had to document
it in a new section of my MarkedDown
Hope someone finds it useful~4
Wanted a change from work and decided to make a small news ( styled markdown ) generator after talking to a Pulsar-Edit maintainer.
Markdown is useful for a quick note, AsciiDoc is useful if you want to go a bit deeper into customization and features.
But I find myself reaching for (Xe)LaTeX quite often once the document I'm trying to compose requires even a little custom content. Am I alone in this? What's your favourite go-to for quickly setting up not-so-standard documents?5
#Suphle Rant 8: Strange star discovered
I was searching for a project I'd starred earlier, on my github feed, when I realised a user had starred suphle at some point but for some reason, it wasn't reflecting on the stargazers. I was half overjoyed and half confused. Overjoyed over unlocking the milestone.
User seemed legit –an Italian with projects in C that were not forked. Followers and commit graph are organic. Did he star in error, feel the project is a stinker, or encounter installation challenges? Luckily, I found his email address but all his repositories are in Italian so I wasn't too sure he'd understand English, or if the mail was being attended to. Yet, I took my chances
He surprisingly got back to me, affirming that the star-unstar was actually deliberate. He withdrew the star cuz project's documentation is not hosted online and still requires npm start.
I try to persuade him by reminding him it's just a one liner but that markdown files are equally rendered directly on github. Never heard from him again, sadly
I'm kind of bothered cos I find it funny I thought suphle's APIs are all cast in stone, but the more I work on the docs, the closer I am to spotting something that doesn't sit right with me, and diving in to modify it. This not only prolongs ETA, there's the risk of someone who may have stumbled upon it and is studying it, having the rug pulled from under their feet. Things like validator rules and route-collection service-coordinators have been converted from methods and classes to native decorators. I guess I'm safe since nobody has indicated any signal to the contrary. It'll be pedantic to start tagging versions for each change.
Another consideration is that these breaking changes would go to the first segment of the semver scheme, which is hilarious because the rate at which I push such changes is so alarming, we'd probably progress through 15 versions under a year12
Typora was the best (closed-source) free markdown editor. As soon as it hit the first stable release, it became non-free. Luckily, you can still download the last beta from https://typora.io/releases/all (click Dev/Beta releases -> scroll down to 'More Beta')