axelson

axelson

Scenic Core Team

I’ve been working on some code using macros today and I’ve come across a few searches on the elixir hexdocs that feel like they really should have results instead of their current no results pages.

Here are the searches and what I think they should point to:

“__using__”

“after_compile”

I searched on the current 1.17.1 docs. Here are the screenshots:


It’s pretty frustrating knowing these concepts exist but not being able to find the specifics in the docs. Are there any previous examples of updating the docs to make specific searches like these possible?

Showing Posts 1 to 4

D4no0

D4no0

Topics related to metaprogramming in general are divided into different sections and are hard to find even to this day.

I would personally recommend reading the book Metaprogramming Elixir by Chris McCord, you will find there a lot of things you were missing before, I always find myself returning to it because honestly I cannot find stuff on hexdocs just as you pointed out.

A simple example of hidden things is the @external_resource attribute that can recompile the source file based on an external file change, quite useful even for some generic use-cases that are not leaning heavily into metaprogramming.

Nicd

Nicd

Now that you opened the discussion, there’s one issue that I just haven’t bothered filing a bug for yet. If you access a search URL directly or just press enter when writing a Module.function type search, like https://hexdocs.pm/elixir/search.html?q=Process.monitor (clickable link), it will show you no results. But if you click on the search bar, the autocomplete will show the results you wanted. It seems the autocomplete is smarter than the actual search engine.

Edit: Well, decided to file that issue: Search page shows no results even though autocomplete finds them · Issue #1930 · elixir-lang/ex_doc · GitHub

josevalim

josevalim

Creator of Elixir

@axelson all of those issues are related to the search engine. The search engine would tokenize by splitting on _ and -, which means __using__ is simply using. I have fixed that issue and the one by @Nicd.

After compile works if you search it as @after_compile, I will try to see if we can make it work as after_compile only.

axelson

axelson OP

Scenic Core Team

Thanks Jose! That’s a great improvement!

— All posts loaded —

Where Next? Top

Trending in Questions Top

Blokh
Hey guys, I’ve got a huge CSV ( around 10 GB ) that needs to be processed hourly Do you guys have any suggestions what is the best prac...
New
RSP87
I’m working on a project that simulates the bumbl example in the programming phoenix book. It acts almost like an email client. We have a...
New
kszambelanczyk
Hello! Could someone please give me a help/sample code, how to delete a file from s3 using waffle/waffle_ecto from Phoenix app. I creat...
New
RemyXRenard
I’m seeing that a list inside a Kino.DataTable will be interpreted as a charlist, even if the Kino.configure() is set to charlists: :as_l...
New
velrest
So my question is quite simple and i have found no conclusive answer on forum, google or AI. Should we use :erlang.float for Integer to ...
New
samoloth
Hi, I’ve just set up an application with ash_authentication. There is only magic link strategy for now, so there is no confirmation add o...
New
FlyingNoodle
If a change or preparation module uses Ash.Changeset.get_argument/2 or Ash.Query.get_argument/2 (or any of the other get_argument functio...
New

Other Trending Topics Top

mudasobwa
I am happy to introduce the very α version of the new programming language compiled to BEAM. Welcome Cure. It has literally three kille...
New
garrison
Hobbes is a low-level distributed database for the Elixir programming language. Hobbes provides a simple, safe, and scalable storage lay...
New
marciok
Hi there! We created Gust: A task orchestrator inspired by Airflow. For those who have never heard about Aiflow, it’s a Python-based wor...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
Damirados
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge & Solve. They are GUI (Emerge) and State management (S...
New
netoum
Corex is an accessible, unstyled UI component library for Phoenix that integrates Zag.js state machines using Vanilla JavaScript and Live...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews