Skip to content

Commit

Permalink
Some typos
Browse files Browse the repository at this point in the history
  • Loading branch information
Azzaare committed Nov 2, 2024
1 parent e7d183d commit 9161661
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 20 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ The only available theme for the moment is using Zurb foundation responsive fron

### Items

Items are guaranteed to be compatible with the main theme (and hopefully new ones will be too).
Items are guaranteed to be compatible with the main theme (and hopefully new ones will be too).

##### `Publications` : a bibliography based on a bibliography file (uses [Bibliography.jl]((https://github.com/Humans-of-Julia/Bibliography.jl)))

Expand Down Expand Up @@ -221,18 +221,18 @@ gitrepo = GitRepo( # currently work only with GitHub

Please note that GitHub will restrict unidentified requests to a certain amount per IP within a time limit (that I don't know the value). If it happens, a message error from GitHub API will be returned.

To circumvent this issue, you can uncomment the line `local_info["auth_tokens"] = "PATH/TO/token.jl'` in `run.jl` (or add it if necessary) **and** edit the `token.jl` by updating your Personnal [Access Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).
To circumvent this issue, you can uncomment the line `local_info["auth_tokens"] = "PATH/TO/token.jl'` in `run.jl` (or add it if necessary) **and** edit the `token.jl` by updating your Personal [Access Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).

`token.jl` aims to store all authentication tokens (for now, just GitHub). It content must be as follow (it is a simple variable containing your PAT):
```julia
# WARNING!
# YOUR TOKENS SHOULD NEVER BE SHARED! IF YOU USE GIT, DON'T FORGET TO ADD `token.jl` TO YOUR `.gitignore` FILE!
# YOU CAN ALSO STORE `token.jl` OUTSIDE OF THE STATICWEBPAGES FOLDER!

github_pat = "YOUR_PERSONAL_ACCESS_TOKEN"
github_pat = "YOUR_PERSONAL_ACCESS_TOKEN"
```

If the token is not valid, a `401: Bad Creditential` error from GitHUb API will be returned.
If the token is not valid, a `401: Bad Creditential` error from GitHub API will be returned.

As the comment states, take care not to push your token to your git repo! A good practice could be to store `token.jl` outside of your git project.

Expand All @@ -242,7 +242,7 @@ As the comment states, take care not to push your token to your git repo! A good
biography = Block(
paragraphs(
"""
Jean-François Baffier is an academic researcher at the RIKEN Center for Advanced Intelligence Project (AIP), and a consultant in Artificial Intelligence, Big Data Science, Data Structures, and Algorithms. As an academic, he gives back to society through fundamental research in computer science supplemented by open source libraries and softwares.
Jean-François Baffier is an academic researcher at the RIKEN Center for Advanced Intelligence Project (AIP), and a consultant in Artificial Intelligence, Big Data Science, Data Structures, and Algorithms. As an academic, he gives back to society through fundamental research in computer science supplemented by open source libraries and software.
""",
"""
paragraph 2
Expand All @@ -266,7 +266,7 @@ research = Block(
Principal Research Projects: Network Interdiction, Compressed Data Structures, Modern Academics, Explainable AI. Other research interest includes Graph Theory, Geometry, Optimization, and Games.
""",
"""
All of this research is supported by Open-Source Softwares and published as peer-review academic papers.
All of this research is supported by Open-Source Softwares and published as peer-review academic papers.

Check warning on line 269 in README.md

View workflow job for this annotation

GitHub Actions / Spell Check with Typos

"Softwares" should be "Software".
"""
),
images()
Expand Down Expand Up @@ -388,7 +388,7 @@ email(

##### Link can be an internal or an external link
```julia
link("research project", "research.hmtl") # inner link
link("research project", "research.html") # inner link
link("StaticWebPages.jl", "https://github.com/Humans-of-Julia/StaticWebPages.jl")
```

Expand Down
5 changes: 2 additions & 3 deletions _typos.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
[default.extend-words]
# Don't correct the surname "Teh"
annote = "annote"
[files]
extend-exclude = ["*.css"]
16 changes: 8 additions & 8 deletions example/content.jl
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
######################################
# General informations
# General information
######################################

info["avatar"] = "pic.jpg"
Expand Down Expand Up @@ -128,13 +128,13 @@ grants = TimeLine(
biography = Block(
paragraphs(
"""
Jean-François Baffier is an academic researcher at the RIKEN Center for Advanced Intelligence Project (AIP), and a consultant in Artificial Intelligence, Big Data Science, Data Structures, and Algorithms. As an academic, he gives back to society through fundamental research in computer science supplemented by open source libraries and softwares.
Jean-François Baffier is an academic researcher at the RIKEN Center for Advanced Intelligence Project (AIP), and a consultant in Artificial Intelligence, Big Data Science, Data Structures, and Algorithms. As an academic, he gives back to society through fundamental research in computer science supplemented by open source libraries and software.
""",
"""
Jean-François graduated Master course at University Paris-Sud and got his Ph.D. from the University of Tokyo. He was a member of the ERATO Kawarabayashi Large Project in Tokyo and Sendai, and a JSPS-CNRS research fellow hosted at the Tokyo Institute of Technology (Japan). He also was a JFLI member from October 2011 to August 2018.
""",
"""
His current $(link("research project", "research.hmtl")) involves the study of the “Analysis of information networks,” the “Smart compression for high-scalability of data structures,” and “Explainable Artificial Intelligence.” Other topic of interest covers modeling of failures and routing in Networks, Game Analysis, and AI for Games.
His current $(link("research project", "research.html")) involves the study of the “Analysis of information networks,” the “Smart compression for high-scalability of data structures,” and “Explainable Artificial Intelligence.” Other topic of interest covers modeling of failures and routing in Networks, Game Analysis, and AI for Games.
""",
"""
Jean-François implemented the StaticWebPages.jl package that was used to generate this website using a simple content file. This is a dummy email: $(email("[email protected]"))
Expand Down Expand Up @@ -192,10 +192,10 @@ page(
topics = Block(
paragraphs(
"""
Principal Research Projects: Network Interdiction, Compressed Data Sructures, Modern Academics, Explainable AI. Other research interest includes Graph Theory, Geometry, Optimization, and Games.
Principal Research Projects: Network Interdiction, Compressed Data Structures, Modern Academics, Explainable AI. Other research interest includes Graph Theory, Geometry, Optimization, and Games.
""",
"""
All of this research is supported by Open-Source Softwares and published as peer-review academic papers.
All of this research is supported by Open-Source Software and published as peer-review academic papers.
"""
),
images()
Expand Down Expand Up @@ -238,7 +238,7 @@ modernac = Block(
context
""",
"""
resutls
results
"""
),
images(
Expand All @@ -252,7 +252,7 @@ explainable = Block(
context
""",
"""
resutls
results
"""
),
images()
Expand All @@ -270,7 +270,7 @@ page(
items = interdiction
),
Section(
title = "Compressed Data Sructures",
title = "Compressed Data Structures",
items = structure
),
Section(
Expand Down
2 changes: 1 addition & 1 deletion ext/SWPGtkExt.jl
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ end

function ui()
# ts = GtkTreeStore(String)
# info = GtkTreeStore.append(ts, Dict(:text => "Informations"))
# info = GtkTreeStore.append(ts, Dict(:text => "Information"))
# tv = populate_tree_view(content)

# # Update the path to your Glade file
Expand Down
2 changes: 1 addition & 1 deletion src/items/publications.jl
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""
Publications
A structure that store all the informations required to build and export a bibloigraphy.
A structure that store all the information required to build and export a bibloigraphy.
"""
struct Publications
parser::Parser
Expand Down

0 comments on commit 9161661

Please sign in to comment.